diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2025-02-27 11:53:30 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2025-02-27 11:53:30 +0100 |
| commit | 4747bb6017a50771f48bee856c839311134eed48 (patch) | |
| tree | 83fa79d5b8beba3b920cb1077c848a0505cfaebb | |
| parent | ac91805f3179fc2225c60e8ccf5a1daa09d43f3d (diff) | |
Add missing case explanation for doc inlined re-export of doc hidden item
| -rw-r--r-- | src/doc/rustdoc/src/write-documentation/re-exports.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/write-documentation/re-exports.md b/src/doc/rustdoc/src/write-documentation/re-exports.md index 34688545c74..ee60916351a 100644 --- a/src/doc/rustdoc/src/write-documentation/re-exports.md +++ b/src/doc/rustdoc/src/write-documentation/re-exports.md @@ -85,7 +85,22 @@ pub struct Hidden; pub use self::Hidden as InlinedHidden; ``` -The same applies on re-exports themselves: if you have multiple re-exports and some of them have +However, if you still want the re-export itself to be visible, you can add the `#[doc(inline)]` +attribute on it: + +```rust,ignore (inline) +// This struct won't be visible. +#[doc(hidden)] +pub struct Hidden; + +#[doc(inline)] +pub use self::Hidden as InlinedHidden; +``` + +In this case, you will have `pub use self::Hidden as InlinedHidden;` in the generated documentation +but no link to the `Hidden` item. + +So back to `#[doc(hidden)]`: if you have multiple re-exports and some of them have `#[doc(hidden)]`, then these ones (and only these) won't appear in the documentation: ```rust,ignore (inline) |
