diff options
| author | panicbit <panicbit.dev@gmail.com> | 2015-10-09 14:08:32 +0200 |
|---|---|---|
| committer | panicbit <panicbit.dev@gmail.com> | 2015-10-09 14:08:32 +0200 |
| commit | cf785d1a9f6a572aba423516ab8541700575fdc2 (patch) | |
| tree | 70cf8d4c9162d9e8e703b0e4c65dcffe218be55c /src | |
| parent | 8dfe0ec8a8baf9b964a5be26b63df1c4ff5b2917 (diff) | |
trpl: mention doc(hidden)
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/trpl/documentation.md | 7 |
1 files changed, 7 insertions, 0 deletions
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 |