Skip to main content

Module passes

Module passes 

Source
Expand description

The definitions of passes which transform crate information.

Re-exportsยง

use crate::clean::Crate; ๐Ÿ”’
use crate::core::DocContext; ๐Ÿ”’

Modulesยง

check_doc_test_visibility ๐Ÿ”’
Looks for items missing (or incorrectly having) doctests.
collect_intra_doc_links ๐Ÿ”’
Resolves intra-doc links (RFC 1946).
collect_trait_impls ๐Ÿ”’
Collects trait impls for each item in the crate.
lint ๐Ÿ”’
Runs several rustdoc lints, consolidating them into a single pass for efficiency and simplicity.
propagate_doc_cfg ๐Ÿ”’
Propagates #[doc(cfg(โ€ฆ))] (RFC 3631) to child items.
propagate_stability ๐Ÿ”’
Propagates stability to child items.
strip_aliased_non_local ๐Ÿ”’
Strips all non-local private aliases items from the output.
strip_hidden ๐Ÿ”’
Strip all #[doc(hidden)] items from the output.
strip_priv_imports ๐Ÿ”’
Strips all private imports (use, extern crate) from a crate.
strip_private ๐Ÿ”’
Strip all private items from the output.
stripper ๐Ÿ”’
A collection of utility functions for the strip_* passes.

Structsยง

ImplStripper ๐Ÿ”’
This stripper discards all impls which reference stripped items
ImportStripper ๐Ÿ”’
This stripper discards all private import statements (use, extern crate)
Store ๐Ÿ”’
Stripper ๐Ÿ”’

Functionsยง

finalize ๐Ÿ”’
To be run after the cache in DocContext has been fully populated.
is_item_reachable ๐Ÿ”’
run ๐Ÿ”’