From e7910322ccc4e4971dc2552959ccbbd7625286b0 Mon Sep 17 00:00:00 2001
From: Steve Klabnik <steve@steveklabnik.com>
Date: Mon, 18 Aug 2014 14:26:14 -0400
Subject: [PATCH] Manual: add information about //!

Fixes #16569
---
 src/doc/rust.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/doc/rust.md b/src/doc/rust.md
index 7fe6585f07ca5..c30e560e474f7 100644
--- a/src/doc/rust.md
+++ b/src/doc/rust.md
@@ -169,6 +169,10 @@ 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"]`).
 
+`//!` comments apply to the parent of the comment, rather than the item that
+follows. `//!` comments are usually used to display information on the crate
+index page.
+
 Non-doc comments are interpreted as a form of whitespace.
 
 ## Whitespace