trpl: mention doc(hidden)

2015-10-09 14:08:32 +02:00 · 2015-10-09 14:08:32 +02:00 · cf785d1a9f
commit cf785d1a9f
parent 8dfe0ec8a8
1 changed files with 7 additions and 0 deletions
--- 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