diff options
| -rw-r--r-- | src/doc/reference.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index f0fdae27ac7..cee2a26f60f 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -104,7 +104,7 @@ comments (`/** ... */`), are interpreted as a special syntax for `doc` `#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into `#[doc="Foo"]`. -Line comments beginning with `//!` and block comments `/*! ... !*/` are +Line comments beginning with `//!` and block comments `/*! ... */` are doc comments that apply to the parent of the comment, rather than the item that follows. That is, they are equivalent to writing `#![doc="..."]` around the body of the comment. `//!` comments are usually used to document |