authorgravatar for sage@sagehane.comSage Hane <sage@sagehane.com> 2026-04-17 16:12:10+09:00
committergravatar for alex@alexrp.comAlex Rønne Petersen <alex@alexrp.com> 2026-04-20 01:59:20+02:00
logc9a761348c8d702cb2b016fe488f3d086918cf44
tree4cdb97391715e5cc90965b10c7e4002e75be438f
parent9a0713db3cd69700ce43ba929d0d9080903ea224
signaturebadge-check Signed by SSH key SHA256:7B/LJ7bpR1eX8aCXSr4mtd5M45VMPKcx9zY8e95b5QM

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
...@@ -2471,7 +2471,7 @@ or...@@ -2471,7 +2471,7 @@ or
2471 <p>Unions can be declared with an enum tag type.2471 <p>Unions can be declared with an enum tag type.
2472 This turns the union into a <em>tagged</em> union, which makes it eligible2472 This turns the union into a <em>tagged</em> union, which makes it eligible
2473 to use with {#link|switch#} expressions. When switching on tagged unions,2473 to use with {#link|switch#} expressions. When switching on tagged unions,
2474 the tag value can be obtained using an additional capture. 2474 the tag value can be obtained using an additional capture.
2475 Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}.2475 Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}.
2476 </p>2476 </p>
2477 {#code|test_tagged_union.zig#}2477 {#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