| author |  Sage Hane <sage@sagehane.com> 2026-04-17 16:12:10+09:00 |
| committer |  Andrew Kelley <andrew@ziglang.org> 2026-04-19 10:12:22-07:00 |
| log | f0649e77097a44e0f99f79715e2f7c1a7f4cb23b |
| tree | 11506ec9bc61bc9bd963f5959bef4dd1a666a4f2 |
| parent | 9b177a7d21250b82cd18677c5c71ab04e431120d |
langref: Clear up terminology used for top-level doc comments
2 files changed, 4 insertions(+), 4 deletions(-)
doc
doc/langref.html.in+2-2
| ... | ... | @@ -429,7 +429,7 @@ |
| 429 | 429 | {#header_open|Top-Level Doc Comments#} |
| 430 | 430 | <p> |
| 431 | 431 | 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 | 433 | </p> |
| 434 | 434 | <p> |
| 435 | 435 | It is a compile error if a top-level doc comment is not placed at the start |
| ... | ... | @@ -2470,7 +2470,7 @@ or |
| 2470 | 2470 | <p>Unions can be declared with an enum tag type. |
| 2471 | 2471 | This turns the union into a <em>tagged</em> union, which makes it eligible |
| 2472 | 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 | 2474 | Tagged unions coerce to their tag type: {#link|Type Coercion: Unions and Enums#}. |
| 2475 | 2475 | </p> |
| 2476 | 2476 | {#code|test_tagged_union.zig#} |
doc/langref/tldoc_comments.zig+2-2
| ... | ... | @@ -3,8 +3,8 @@ |
| 3 | 3 | //! depend on libc, but will use functions from it if available. |
| 4 | 4 | |
| 5 | 5 | const S = struct { |
| 6 | //! Top level comments are allowed inside a container other than a module, | |
| 7 | //! but it is not very useful. Currently, when producing the package | |
| 6 | //! Top level comments are allowed inside containers other than source | |
| 7 | //! files, but it is not very useful. Currently, when producing the package | |
| 8 | 8 | //! documentation, these comments are ignored. |
| 9 | 9 | }; |
| 10 | 10 |