From 159d1ab540cd53f1e63db0e00a50180d535a8bce Mon Sep 17 00:00:00 2001 From: Kaivo Anastetiks Date: Tue, 5 Jul 2016 13:17:16 -0400 Subject: [PATCH] Add a section about crate documentation. --- src/doc/book/documentation.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/doc/book/documentation.md b/src/doc/book/documentation.md index 3c6643fbfe1..6292ba9aac4 100644 --- a/src/doc/book/documentation.md +++ b/src/doc/book/documentation.md @@ -486,6 +486,17 @@ you have a module in `foo.rs`, you'll often open its code and see this: //! The `foo` module contains a lot of useful functionality blah blah blah ``` +### Crate documentation + +Crates can be documented by placing an inner doc comment (`//!`) at the +beginning of the crate root, aka `lib.rs`: + +```rust +//! This is documentation for the `foo` crate. +//! +//! The foo crate is meant to be used for bar. +``` + ### Documentation comment style Check out [RFC 505][rfc505] for full conventions around the style and format of