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

Rollup merge of #24740 - mbrubeck:reference, r=steveklabnik

Browse Source 
r? @steveklabnik
This commit is contained in:
Manish Goregaokar 2015-04-24 09:48:33 +05:30
commit 9863f2c4f3
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/doc/reference.md
View File

@ -149,9 +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"]`).
`//!` comments apply to the parent of the comment, rather than the item that
follows. `//!` 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.