Skip to content

Commit 35f1d81

Browse files
committed
Note that hidden and private items will have an icon when shown.
1 parent 6fb8636 commit 35f1d81

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

src/doc/rustdoc/src/command-line-arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ mod private { // this item is private and will not be documented
100100
}
101101
```
102102

103-
`--document-private-items` includes all non-public in the generated documentation except for `#[doc(hidden)]` items.
103+
`--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.
104104

105105

106106
## `-L`/`--library-path`: where to look for dependencies

src/doc/rustdoc/src/unstable-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ the flag in question to Rustdoc on the command-line. To do this from Cargo, you
264264
By default, `rustdoc` does not document items that are annotated with
265265
[`#[doc(hidden)]`](write-documentation/the-doc-attribute.html#hidden).
266266

267-
`--document-hidden-items` causes all items to be documented as if they did not have `#[doc(hidden)]`.
267+
`--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.
268268

269269
Here is a table that fully describes which items are documented with each combination of `--document-hidden-items` and `--document-private-items`:
270270

0 commit comments

Comments
 (0)