From cf785d1a9f6a572aba423516ab8541700575fdc2 Mon Sep 17 00:00:00 2001 From: panicbit Date: Fri, 9 Oct 2015 14:08:32 +0200 Subject: [PATCH] trpl: mention doc(hidden) --- src/doc/trpl/documentation.md | 7 +++++++ 1 file changed, 7 insertions(+) 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 -- 2.44.0