diff options
| author | John Schmidt <3405586+schmee@users.noreply.github.com> | 2019-02-18 23:53:41 +0100 |
|---|---|---|
| committer | Andrew Kelley <andrew@ziglang.org> | 2019-02-18 17:53:41 -0500 |
| commit | 99adda9df5a5ae6c16b60da6ba7d57fd2154b81c (patch) | |
| tree | 7e73e11a12d86004b2954d46c54bece041299017 | |
| parent | 043090020f5052fdee0fffc02dc7ef379ea63fd0 (diff) | |
| download | zig-99adda9df5a5ae6c16b60da6ba7d57fd2154b81c.tar.gz zig-99adda9df5a5ae6c16b60da6ba7d57fd2154b81c.zip | |
Some function doc tweaks (#1961)
* Add docs for the inline function attribute
* Remove outdated comment
Seems like a leftover from when implicit returns were around.
* Consistent terminology
| -rw-r--r-- | doc/langref.html.in | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/langref.html.in b/doc/langref.html.in index 34cae7282d..3a3eaf708c 100644 --- a/doc/langref.html.in +++ b/doc/langref.html.in @@ -3169,7 +3169,6 @@ const assert = @import("std").debug.assert; // Functions are declared like this fn add(a: i8, b: i8) i8 { if (a == 0) { - // You can still return manually if needed. return b; } @@ -3193,12 +3192,18 @@ fn abort() noreturn { while (true) {} } -// nakedcc makes a function not have any function prologue or epilogue. +// The nakedcc specifier makes a function not have any function prologue or epilogue. // This can be useful when integrating with assembly. nakedcc fn _start() noreturn { abort(); } +// The inline specifier forces a function to be inlined at all call sites. +// If the function cannot be inlined, it is a compile-time error. +inline fn shiftLeftOne(a: u32) u32 { + return a << 1; +} + // The pub specifier allows the function to be visible when importing. // Another file can use @import and call sub2 pub fn sub2(a: i8, b: i8) i8 { return a - b; } |
