Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document top-level doc comments, per #2288. #5801

Merged
merged 1 commit into from
Jul 13, 2020
Merged

Document top-level doc comments, per #2288. #5801

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/langref.html.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,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#}
Vexu marked this conversation as resolved.
Show resolved Hide resolved
<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#}
Expand Down