diff options
| author | mdinger <mdinger.bugzilla@gmail.com> | 2015-11-13 16:06:00 -0500 |
|---|---|---|
| committer | mdinger <mdinger.bugzilla@gmail.com> | 2015-11-13 16:06:00 -0500 |
| commit | 4e74f9b874700c652e3fa768e08293b91a36ea34 (patch) | |
| tree | c2ba8203fb6767da6cabb77dd3808f5730c8cad9 | |
| parent | 3beb159809d2f1c9daf9c73d8fd62a4383742bc4 (diff) | |
| download | rust-4e74f9b874700c652e3fa768e08293b91a36ea34.tar.gz rust-4e74f9b874700c652e3fa768e08293b91a36ea34.zip | |
Document block doc comments better
| -rw-r--r-- | src/doc/reference.md | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index 2ada86115b6..de9352a4275 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -99,13 +99,12 @@ Comments in Rust code follow the general C++ style of line (`//`) and block (`/* ... */`) comment forms. Nested block comments are supported. Line comments beginning with exactly _three_ slashes (`///`), and block -comments beginning with exactly one repeated asterisk in the block-open -sequence (`/**`), are interpreted as a special syntax for `doc` +comments (`/** ... */`), are interpreted as a special syntax for `doc` [attributes](#attributes). That is, they are equivalent to writing `#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into `#[doc="Foo"]`. -Line comments beginning with `//!` and block comments beginning with `/*!` are +Line comments beginning with `//!` and block comments `/*! ... !*/` 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 document |