2021-12-09 12:16:13 -06:00
|
|
|
Available passes for running rustdoc:
|
|
|
|
|
check_doc_test_visibility - run various visibility-related lints on doctests
|
2024-05-09 12:58:10 -05:00
|
|
|
strip-aliased-non-local - strips all non-local private aliased items from the output
|
2021-12-09 12:16:13 -06:00
|
|
|
strip-hidden - strips all `#[doc(hidden)]` items from the output
|
|
|
|
|
strip-private - strips all private items from a crate which cannot be seen externally, implies strip-priv-imports
|
|
|
|
|
strip-priv-imports - strips all private import statements (`use`, `extern crate`) from a crate
|
|
|
|
|
propagate-doc-cfg - propagates `#[doc(cfg(...))]` to child items
|
2024-09-29 20:20:17 -05:00
|
|
|
propagate-stability - propagates stability to child items
|
2021-12-09 12:16:13 -06:00
|
|
|
collect-intra-doc-links - resolves intra-doc links
|
|
|
|
|
collect-trait-impls - retrieves trait impls for items in the crate
|
|
|
|
|
calculate-doc-coverage - counts the number of items with and without documentation
|
2022-11-22 21:42:49 -06:00
|
|
|
run-lints - runs some of rustdoc's lints
|
2021-12-09 12:16:13 -06:00
|
|
|
|
|
|
|
|
Default passes for rustdoc:
|
|
|
|
|
collect-trait-impls
|
|
|
|
|
check_doc_test_visibility
|
2024-05-09 12:58:10 -05:00
|
|
|
strip-aliased-non-local
|
2021-12-09 12:16:13 -06:00
|
|
|
strip-hidden (when not --document-hidden-items)
|
|
|
|
|
strip-private (when not --document-private-items)
|
|
|
|
|
strip-priv-imports (when --document-private-items)
|
|
|
|
|
collect-intra-doc-links
|
|
|
|
|
propagate-doc-cfg
|
2024-09-29 20:20:17 -05:00
|
|
|
propagate-stability
|
2022-11-22 21:42:49 -06:00
|
|
|
run-lints
|
2021-12-09 12:16:13 -06:00
|
|
|
|
|
|
|
|
Passes run with `--show-coverage`:
|
|
|
|
|
strip-hidden (when not --document-hidden-items)
|
|
|
|
|
strip-private (when not --document-private-items)
|
|
|
|
|
calculate-doc-coverage
|
