From: panicbit Date: Fri, 9 Oct 2015 12:08:32 +0000 (+0200) Subject: trpl: mention doc(hidden) X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=cf785d1a9f6a572aba423516ab8541700575fdc2;p=rust.git trpl: mention doc(hidden) --- diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md index abd09a67803..8cb58ecf2c7 100644 --- a/src/doc/trpl/documentation.md +++ b/src/doc/trpl/documentation.md @@ -571,6 +571,13 @@ leave something undocumented. This is done by using `allow`: 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