OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Also mention /*! doc comments.

Browse Source
This commit is contained in:
Matt Brubeck 2015-04-23 14:25:30 -07:00
parent 1b878379e9
commit 4cab21c003
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/doc/reference.md
View File

@ -149,10 +149,11 @@ sequence (`/**`), are interpreted as a special syntax for `doc`
`#[doc="..."]` around the body of the comment (this includes the comment
characters themselves, ie `/// Foo` turns into `#[doc="/// Foo"]`).
Line comments beginning with `//!` 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 display information on the crate index page.
Line comments beginning with `//!` and block comments beginning with `/*!` 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 display
information on the crate index page.
Non-doc comments are interpreted as a form of whitespace.