]> git.lizzy.rs Git - rust.git/commitdiff
trpl: mention doc(hidden)
authorpanicbit <panicbit.dev@gmail.com>
Fri, 9 Oct 2015 12:08:32 +0000 (14:08 +0200)
committerpanicbit <panicbit.dev@gmail.com>
Fri, 9 Oct 2015 12:08:32 +0000 (14:08 +0200)
src/doc/trpl/documentation.md

index abd09a6780352953ac2696839087c825b7528244..8cb58ecf2c74713fb5f68f79e4af666335c99af7 100644 (file)
@@ -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