diff options
| author | est31 <MTest31@outlook.com> | 2016-01-28 18:39:39 +0100 |
|---|---|---|
| committer | est31 <MTest31@outlook.com> | 2016-01-28 18:39:39 +0100 |
| commit | 205f836ab8b8fb67558ccfe611f9afac5a147825 (patch) | |
| tree | 72f22c4efd1981acf3ed283195a79b7783d060d7 | |
| parent | 077f4eeb8485e5a1437f6e27973a907ac772b616 (diff) | |
| download | rust-205f836ab8b8fb67558ccfe611f9afac5a147825.tar.gz rust-205f836ab8b8fb67558ccfe611f9afac5a147825.zip | |
Fix reference info about parent doc block comments
Block comments don't have to be in the format `/*! ... !*/` in order to be read as doc comments about the parent block. The format `/*! ... */` is enough.
| -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 |