Skip to content

Commit 3570095

Browse files
committed
auto merge of #16583 : steveklabnik/rust/gh16569, r=pcwalton
Fixes #16569
2 parents 9af4e32 + e791032 commit 3570095

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/doc/rust.md

+4
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,10 @@ sequence (`/**`), are interpreted as a special syntax for `doc`
169169
`#[doc="..."]` around the body of the comment (this includes the comment
170170
characters themselves, ie `/// Foo` turns into `#[doc="/// Foo"]`).
171171

172+
`//!` comments apply to the parent of the comment, rather than the item that
173+
follows. `//!` comments are usually used to display information on the crate
174+
index page.
175+
172176
Non-doc comments are interpreted as a form of whitespace.
173177

174178
## Whitespace

0 commit comments

Comments
 (0)