authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-03-06 16:01:26-05:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-03-06 16:01:26-05:00
log0e5b48d1a2cd5bcd22be4f4e14c80c3335f70985
tree2c5adff99ad0a96838d94bd35b653fea8aaae1d6
parent3dc8cb12e81dde268f558de1cf2c3d288bd1939f
signaturelock-open Commit is signed but in an unrecognized format.

fix `@embedFile` docs

1 files changed, 6 insertions(+), 4 deletions(-)

doc/langref.html.in+6-4
...@@ -7281,11 +7281,13 @@ test "main" {...@@ -7281,11 +7281,13 @@ test "main" {
7281 {#see_also|@divFloor|@divExact#}7281 {#see_also|@divFloor|@divExact#}
7282 {#header_close#}7282 {#header_close#}
7283 {#header_open|@embedFile#}7283 {#header_open|@embedFile#}
7284 <pre>{#syntax#}@embedFile(comptime path: []const u8) [X]u8{#endsyntax#}</pre>7284 <pre>{#syntax#}@embedFile(comptime path: []const u8) *const [X:0]u8{#endsyntax#}</pre>
7285 <p>7285 <p>
7286 This function returns a compile time constant fixed-size array with length7286 This function returns a compile time constant pointer to null-terminated,
7287 equal to the byte count of the file given by {#syntax#}path{#endsyntax#}. The contents of the array7287 fixed-size array with length equal to the byte count of the file given by
7288 are the contents of the file.7288 {#syntax#}path{#endsyntax#}. The contents of the array are the contents of the file.
7289 This is equivalent to a {#link|string literal|String Literals and Character Literals#}
7290 with the file contents.
7289 </p>7291 </p>
7290 <p>7292 <p>
7291 {#syntax#}path{#endsyntax#} is absolute or relative to the current file, just like {#syntax#}@import{#endsyntax#}.7293 {#syntax#}path{#endsyntax#} is absolute or relative to the current file, just like {#syntax#}@import{#endsyntax#}.