Skip to content

Commit cf785d1

Browse files
committed
trpl: mention doc(hidden)
1 parent 8dfe0ec commit cf785d1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/doc/trpl/documentation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -571,6 +571,13 @@ leave something undocumented. This is done by using `allow`:
571571
struct Undocumented;
572572
```
573573

574+
You might even want to hide items from the documentation completely:
575+
576+
```rust
577+
#[doc(hidden)]
578+
struct Hidden;
579+
```
580+
574581
### Controlling HTML
575582

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

0 commit comments

Comments
 (0)