Skip to content

Commit

Permalink
Auto merge of #28922 - panicbit:trpl-missing-docs, r=steveklabnik
Browse files Browse the repository at this point in the history
  • Loading branch information
bors committed Oct 10, 2015
2 parents e6abcbc + cf785d1 commit e3cd872
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions src/doc/trpl/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,38 @@ extern crate foo;
pub use foo::bar;
```

## Missing documentation

Sometimes you want to make sure that every single public 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;
```

You might even want to hide items from the documentation completely:

```rust
#[doc(hidden)]
struct Hidden;
```

### Controlling HTML

You can control a few aspects of the HTML that `rustdoc` generates through the
Expand Down

0 comments on commit e3cd872

Please sign in to comment.