OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rollup merge of #34667 - KaivoAnastetiks:fix/crate-documentation, r=Manishearth

Browse Source 
Add a section about crate documentation.

Fixes #34329
?r @steveklabnik
This commit is contained in:
Steve Klabnik 2016-07-06 19:13:08 -04:00 committed by GitHub
commit 8c3efd20e4
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/doc/book/documentation.md
View File

@ -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 //! 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 ### Documentation comment style
Check out [RFC 505][rfc505] for full conventions around the style and format of Check out [RFC 505][rfc505] for full conventions around the style and format of