diff options
| author | Hashi364 <49736221+Kiyoshi364@users.noreply.github.com> | 2023-03-13 11:47:20 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-13 14:47:20 +0000 |
| commit | 4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99 (patch) | |
| tree | 35ad35e77e2f9266e4b1bbff873d1adfe378e23e /doc/langref.html.in | |
| parent | adc6dec26b8ba9f79aabc4b69ae689acf4c6767d (diff) | |
| download | zig-4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99.tar.gz zig-4942e4e8701b9a137d7f30fcb8ac1bc2d46f2a99.zip | |
Resolve docs inconsistency with Overflow builtins
In 41 (Undefined Behavior) . 5 (Integer Overflow) . 3 (Builtin Overflow Functions), it is stated that
> These builtins return a bool of whether or not overflow occurred, as well as returning the overflowed bits:
> * @addWithOverflow
> * @subWithOverflow
> * @mulWithOverflow
> * @shlWithOverflow
but in their definition says that it returns a `tuple`/`struct`.
Example;
`@addWithOverflow(a: anytype, b: anytype) struct { @TypeOf(a, b), u1 }`
Co-authored-by: zooster <r00ster91@proton.me>
Diffstat (limited to 'doc/langref.html.in')
| -rw-r--r-- | doc/langref.html.in | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/langref.html.in b/doc/langref.html.in index 9cee35caa2..991fd0c3e6 100644 --- a/doc/langref.html.in +++ b/doc/langref.html.in @@ -9804,8 +9804,8 @@ pub fn main() !void { {#header_close#} {#header_open|Builtin Overflow Functions#} <p> - These builtins return a {#syntax#}bool{#endsyntax#} of whether or not overflow - occurred, as well as returning the overflowed bits: + These builtins return a tuple containing whether there was an overflow + (as a {#syntax#}u1{#endsyntax#}) and the possibly overflowed bits of the operation: </p> <ul> <li>{#link|@addWithOverflow#}</li> |