From 4cab21c00344eac1b8a6325c0d6254bc113022ad Mon Sep 17 00:00:00 2001 From: Matt Brubeck Date: Thu, 23 Apr 2015 14:25:30 -0700 Subject: [PATCH] Also mention `/*!` doc comments. --- src/doc/reference.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/doc/reference.md b/src/doc/reference.md index 8a6f15a1ba4..44266fb4050 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -149,10 +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"]`). -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. +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.