1
Fork 0

trpl: mention missing_docs lint

This commit is contained in:
panicbit 2015-10-09 03:00:43 +02:00
parent 11eda66df8
commit 6b5eb70e1d

View file

@ -546,6 +546,31 @@ extern crate foo;
pub use foo::bar;
```
## Missing documentation
Sometimes you want to make sure that every single thing in your project is
documented, especially when you are working on a library. Rust allows you to
to generate warnings or errors, when an item is missing documentation.
To generate warnings you use `warn`:
```rust
#![warn(missing_docs)]
```
And to generate errors you use `deny`:
```rust,ignore
#![deny(missing_docs)]
```
There are cases where you want to disable these warnings/errors to explicitly
leave something undocumented. This is done by using `allow`:
```rust
#[allow(missing_docs)]
struct Undocumented;
```
### Controlling HTML
You can control a few aspects of the HTML that `rustdoc` generates through the