diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2016-01-29 20:19:39 +0530 |
|---|---|---|
| committer | Manish Goregaokar <manishsmail@gmail.com> | 2016-01-29 20:19:39 +0530 |
| commit | 37316e8d052c35b883f1e530ccf755cbbb7a8bda (patch) | |
| tree | 94ccbaf080ff1b2b5190a271fce8417b7ff94298 | |
| parent | 050c587e9e6071e285689aa7d383e40a14f97fd3 (diff) | |
| parent | 205f836ab8b8fb67558ccfe611f9afac5a147825 (diff) | |
Rollup merge of #31264 - est31:block_coment_parent, r=alexcrichton
Block comments don't have to be in the format `/*! ... !*/` in order to be read as doc comments about the parent block. The format `/*! ... */` is enough.
| -rw-r--r-- | src/doc/reference.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index 46fdee2bb5a..9c0538e6a3c 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -104,7 +104,7 @@ comments (`/** ... */`), are interpreted as a special syntax for `doc` `#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into `#[doc="Foo"]`. -Line comments beginning with `//!` and block comments `/*! ... !*/` 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 |