authorgravatar for nathan@nmichaels.orgNathan Michaels <nathan@nmichaels.org> 2020-07-05 18:39:28-04:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2020-07-13 22:57:23+00:00
logbc900cdeaf3434acc150a8db203eb5a485c09b67
tree9e56e1a0d357feee189687b55e1d65ed4a73e435
parentfabdef44a8618a64835f63af544e4944a58bed46

Document top-level doc comments, per #2288.


1 files changed, 12 insertions(+), 0 deletions(-)

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