mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify that //! comments are also doc comments.

Browse Source
This commit is contained in:
Matt Brubeck 2015-04-23 14:03:25 -07:00
parent 65f889919d
commit 1b878379e9
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/doc/reference.md
View File

@ -149,9 +149,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.
Line 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.