diff options
| author | Chris Watson <cawatson1993@gmail.com> | 2020-06-30 19:52:02 -0600 |
|---|---|---|
| committer | Andrew Kelley <andrew@ziglang.org> | 2020-07-01 22:22:30 +0000 |
| commit | b8d5b3e6110023e17e1c191afa1d143f8b71fe4f (patch) | |
| tree | f6ed3b9b44a74be51be07b5d695091678496783e /doc | |
| parent | 7eed220924062aa68586278568df6731afb2a20e (diff) | |
| download | zig-b8d5b3e6110023e17e1c191afa1d143f8b71fe4f.tar.gz zig-b8d5b3e6110023e17e1c191afa1d143f8b71fe4f.zip | |
Add documentation for @src() builtin
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/langref.html.in | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/langref.html.in b/doc/langref.html.in index aef7b09798..dfbb93decf 100644 --- a/doc/langref.html.in +++ b/doc/langref.html.in @@ -8030,7 +8030,29 @@ test "vector @splat" { </p> {#see_also|Vectors|@shuffle#} {#header_close#} + {#header_open|@src#} + <pre>{#syntax#}@src() std.builtin.SourceLocation{#endsyntax#}</pre> + <p> + Returns a {#syntax#}SourceLocation{#endsyntax#} struct representing the function's name and location in the source code. This must be called in a function. + </p> + {#code_begin|test#} +const std = @import("std"); +const expect = std.testing.expect; + +test "@src" { + doTheTest(); +} + +fn doTheTest() void { + const src = @src(); + expect(src.line == 9); + expect(src.column == 17); + expect(std.mem.endsWith(u8, src.fn_name, "doTheTest")); + expect(std.mem.endsWith(u8, src.file, "test.zig")); +} + {#code_end#} + {#header_close#} {#header_open|@sqrt#} <pre>{#syntax#}@sqrt(value: var) @TypeOf(value){#endsyntax#}</pre> <p> |
