authorgravatar for sage@sagehane.comSage Hane <sage@sagehane.com> 2026-04-17 16:12:10+09:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2026-04-19 10:12:22-07:00
logf0649e77097a44e0f99f79715e2f7c1a7f4cb23b
tree11506ec9bc61bc9bd963f5959bef4dd1a666a4f2
parent9b177a7d21250b82cd18677c5c71ab04e431120d

langref: Clear up terminology used for top-level doc comments

2 files changed, 4 insertions(+), 4 deletions(-)

doc/langref.html.in+2-2
...@@ -429,7 +429,7 @@...@@ -429,7 +429,7 @@
429 {#header_open|Top-Level Doc Comments#}429 {#header_open|Top-Level Doc Comments#}
430 <p>430 <p>
431 A top-level doc comment is one that begins with two slashes and an exclamation431 A top-level doc comment is one that begins with two slashes and an exclamation
432 point: {#syntax#}//!{#endsyntax#}; it documents the current module.432 point: {#syntax#}//!{#endsyntax#}; it documents the current source file.
433 </p>433 </p>
434 <p>434 <p>
435 It is a compile error if a top-level doc comment is not placed at the start435 It is a compile error if a top-level doc comment is not placed at the start
...@@ -2470,7 +2470,7 @@ or...@@ -2470,7 +2470,7 @@ or
2470 <p>Unions can be declared with an enum tag type.2470 <p>Unions can be declared with an enum tag type.
2471 This turns the union into a <em>tagged</em> union, which makes it eligible2471 This turns the union into a <em>tagged</em> union, which makes it eligible
2472 to use with {#link|switch#} expressions. When switching on tagged unions,2472 to use with {#link|switch#} expressions. When switching on tagged unions,
2473 the tag value can be obtained using an additional capture. 2473 the tag value can be obtained using an additional capture.
2474 Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}.2474 Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}.
2475 </p>2475 </p>
2476 {#code|test_tagged_union.zig#}2476 {#code|test_tagged_union.zig#}
doc/langref/tldoc_comments.zig+2-2
...@@ -3,8 +3,8 @@...@@ -3,8 +3,8 @@
3//! depend on libc, but will use functions from it if available.3//! depend on libc, but will use functions from it if available.
44
5const S = struct {5const S = struct {
6 //! Top level comments are allowed inside a container other than a module,6 //! Top level comments are allowed inside containers other than source
7 //! but it is not very useful. Currently, when producing the package7 //! files, but it is not very useful. Currently, when producing the package
8 //! documentation, these comments are ignored.8 //! documentation, these comments are ignored.
9};9};
1010