Skip to content

[rustdoc] Additional notes on reexport chain with #[doc(hidden)] #137984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
xizheyin wants to merge 1 commit into from
Closed

[rustdoc] Additional notes on reexport chain with #[doc(hidden)] #137984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/doc/rustdoc/src/write-documentation/re-exports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ pub mod public_mod {
pub use self::public_mod::Public;
```

If an item has `#[doc(hidden)]`, it won't be inlined (nor visible in the generated documentation):
If an item has a reexport chain with `#[doc(hidden)]`,
and the item has no other attributes,
it won't be visible in the generated documentation:

```rust,ignore (inline)
// This struct won't be visible.
Expand Down
Loading