From 6b5eb70e1db79f1fca9f01b6a671e822d6553ccd Mon Sep 17 00:00:00 2001 From: panicbit Date: Fri, 9 Oct 2015 03:00:43 +0200 Subject: [PATCH] trpl: mention missing_docs lint --- src/doc/trpl/documentation.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md index 1e1b2e2d4588..b9de4110a664 100644 --- a/src/doc/trpl/documentation.md +++ b/src/doc/trpl/documentation.md @@ -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