]> git.lizzy.rs Git - rust.git/commitdiff
Fix reference info about parent doc block comments
authorest31 <MTest31@outlook.com>
Thu, 28 Jan 2016 17:39:39 +0000 (18:39 +0100)
committerest31 <MTest31@outlook.com>
Thu, 28 Jan 2016 17:39:39 +0000 (18:39 +0100)
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.

src/doc/reference.md

index f0fdae27ac7fb33ccd4728db2f1277ba0290dad5..cee2a26f60fc4c78e9be720e0fe65013d73d0433 100644 (file)
@@ -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