bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Manual: add information about //!

Browse source 
Fixes #16569
This commit is contained in:
Steve Klabnik 2014-08-18 14:26:14 -04:00
parent 776c17f476
commit e7910322cc
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/doc/rust.md
View file

@ -169,6 +169,10 @@ 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.
Non-doc comments are interpreted as a form of whitespace.
## Whitespace