user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rustdoc book: acknowlage --document-hidden-items

Browse source
This commit is contained in:
binarycat 2024-11-10 15:04:48 -06:00
parent 7028d9318f
commit ff7533e1ac
3 changed files with 23 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/doc/rustdoc/src/command-line-arguments.md
View file

@ -100,7 +100,8 @@ mod private { // this item is private and will not be documented
}
```
`--document-private-items` documents all items, even if they're not public.
`--document-private-items` includes all non-public items in the generated documentation except for `#[doc(hidden)]` items. Private items will be shown with a 🔒 icon.
## `-L`/`--library-path`: where to look for dependencies

19
src/doc/rustdoc/src/unstable-features.md
View file

@ -258,6 +258,25 @@ themselves marked as unstable. To use any of these options, pass `-Z unstable-op
the flag in question to Rustdoc on the command-line. To do this from Cargo, you can either use the
`RUSTDOCFLAGS` environment variable or the `cargo rustdoc` command.
### `--document-hidden-items`: Show items that are `#[doc(hidden)]`
<span id="document-hidden-items"></span>
By default, `rustdoc` does not document items that are annotated with
[`#[doc(hidden)]`](write-documentation/the-doc-attribute.html#hidden).
`--document-hidden-items` causes all items to be documented as if they did not have `#[doc(hidden)]`, except that hidden items will be shown with a 👻 icon.
Here is a table that fully describes which items are documented with each combination of `--document-hidden-items` and `--document-private-items`:
| rustdoc flags | items that will be documented |
|---------------------------------|---------------------------------------|
| neither flag | only public items that are not hidden |
| only `--document-hidden-items` | all public items |
| only `--document-private-items` | all items that are not hidden |
| both flags | all items |
### `--markdown-before-content`: include rendered Markdown before the content
* Tracking issue: [#44027](https://github.com/rust-lang/rust/issues/44027)

5
src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View file

@ -230,9 +230,8 @@ If you want to know more about inlining rules, take a look at the
<span id="dochidden"></span>
Any item annotated with `#[doc(hidden)]` will not appear in the documentation, unless
the `strip-hidden` pass is removed. Re-exported items where one of its ancestors has
`#[doc(hidden)]` will be considered the same as private.
Any item annotated with `#[doc(hidden)]` will not appear in the documentation,
unless the [`--document-hidden-items`](../unstable-features.md#document-hidden-items) flag is used.
You can find more information in the [`re-exports` chapter](./re-exports.md).