From 205f836ab8b8fb67558ccfe611f9afac5a147825 Mon Sep 17 00:00:00 2001 From: est31 Date: Thu, 28 Jan 2016 18:39:39 +0100 Subject: [PATCH] Fix reference info about parent doc block comments 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. --- src/doc/reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/reference.md b/src/doc/reference.md index f0fdae27ac7..cee2a26f60f 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 -- 2.44.0