diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rust.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/doc/rust.md b/src/doc/rust.md index 7fe6585f07c..c30e560e474 100644 --- a/src/doc/rust.md +++ b/src/doc/rust.md @@ -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 |