Skip to content

Commit d4b0b00

Browse files
committed
interaction table for --document-hidden-items and --document-private-items
1 parent ac923fc commit d4b0b00

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,16 @@ By default, `rustdoc` does not document items that are annotated with
266266

267267
`--document-hidden-items` causes all items to be documented as if they did not have `#[doc(hidden)]`.
268268

269-
Items that are hidden and private will only be documented if both `--document-hidden-items` *and* `--document-private-items` are specified.
269+
Here is a table that fully describes which items are documented with each combination of `--document-hidden-items` and `--document-private-items`:
270+
271+
272+
| rustdoc flags | items that will be documented |
273+
|---------------------------------|---------------------------------------|
274+
| neither flag | only public items that are not hidden |
275+
| only `--document-hidden-items` | all public items |
276+
| only `--document-private-items` | all items that are not hidden |
277+
| both flags | all items |
278+
270279

271280
### `--markdown-before-content`: include rendered Markdown before the content
272281

0 commit comments

Comments
 (0)