Nixyri/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2025-02-05 20:30:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document top-level doc comments, per #2288.

Browse Source
This commit is contained in:
Nathan Michaels 2020-07-05 18:39:28 -04:00 committed by Andrew Kelley
parent fabdef44a8
commit bc900cdeaf
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/langref.html.in
View File

@ -392,6 +392,18 @@ const Timestamp = struct {
in the middle of an expression, or just before a non-doc comment.
</p>
{#header_close#}
{#header_open|Top-Level Doc Comments#}
<p>User documentation that doesn't belong to whatever
immediately follows it, like package-level documentation, goes
in top-level doc comments. A top-level doc comment is one that
begins with two slashes and an exclamation point:
{#syntax#}//!{#endsyntax#}.</p>
{#code_begin|syntax|tldoc_comments#}
//! This module provides functions for retrieving the current date and
//! time with varying degrees of precision and accuracy. It does not
//! depend on libc, but will use functions from it if available.
{#code_end#}
{#header_close#}
{#header_close#}
{#header_open|Values#}
{#code_begin|exe|values#}