diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2015-04-24 09:48:33 +0530 |
|---|---|---|
| committer | Manish Goregaokar <manishsmail@gmail.com> | 2015-04-24 09:48:33 +0530 |
| commit | 9863f2c4f353c600afaa159b697513ddbd1ff8fa (patch) | |
| tree | ac8e3e21d0f6e880830e57283efcd8800ba08a1a /src/doc/reference.md | |
| parent | 5a61d43526b97d864b68a98008837a09629f2573 (diff) | |
| parent | 4cab21c00344eac1b8a6325c0d6254bc113022ad (diff) | |
| download | rust-9863f2c4f353c600afaa159b697513ddbd1ff8fa.tar.gz rust-9863f2c4f353c600afaa159b697513ddbd1ff8fa.zip | |
Rollup merge of #24740 - mbrubeck:reference, r=steveklabnik
r? @steveklabnik
Diffstat (limited to 'src/doc/reference.md')
| -rw-r--r-- | src/doc/reference.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index b74f1ff2139..3e8aa7c3ad0 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -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. |