nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-04-28 02:57:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #137719 - GuillaumeGomez:missing-doc, r=notriddle

Browse Source 
Add missing case explanation for doc inlined re-export of doc hidden item

This case was not covered in the rustdoc book as uncovered in #137342.

r? ``@notriddle``
This commit is contained in:
Matthias Krüger 2025-03-01 11:33:59 +01:00 committed by GitHub
commit db12f00627
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/doc/rustdoc/src/write-documentation/re-exports.md
View File

@ -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)