diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2014-08-18 14:26:14 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2014-08-18 14:26:25 -0400 |
| commit | e7910322ccc4e4971dc2552959ccbbd7625286b0 (patch) | |
| tree | a3eb35a1d99159f06b68a71db9ed62aaa12f614f /src | |
| parent | 776c17f476c4be92f6cfe4dab528886973ea8c03 (diff) | |
| download | rust-e7910322ccc4e4971dc2552959ccbbd7625286b0.tar.gz rust-e7910322ccc4e4971dc2552959ccbbd7625286b0.zip | |
Manual: add information about //!
Fixes #16569
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 |