Module rustdoc::passes

Contains information about "passes", used to modify crate information during the documentation process.

Re-exports

pub use stripper::*;

pub use self::non_autolinks::CHECK_NON_AUTOLINKS;

pub use self::collapse_docs::COLLAPSE_DOCS;

pub use self::strip_hidden::STRIP_HIDDEN;

pub use self::strip_private::STRIP_PRIVATE;

pub use self::strip_priv_imports::STRIP_PRIV_IMPORTS;

pub use self::unindent_comments::UNINDENT_COMMENTS;

pub use self::propagate_doc_cfg::PROPAGATE_DOC_CFG;

pub use self::collect_intra_doc_links::COLLECT_INTRA_DOC_LINKS;

pub use self::doc_test_lints::CHECK_PRIVATE_ITEMS_DOC_TESTS;

pub use self::collect_trait_impls::COLLECT_TRAIT_IMPLS;

pub use self::check_code_block_syntax::CHECK_CODE_BLOCK_SYNTAX;

pub use self::calculate_doc_coverage::CALCULATE_DOC_COVERAGE;

pub use self::html_tags::CHECK_INVALID_HTML_TAGS;

Modules

calculate_doc_coverage
check_code_block_syntax
collapse_docs
collect_intra_doc_links	This module implements RFC 1946: Intra-rustdoc-links
collect_trait_impls
doc_test_lints	This pass is overloaded and runs two different lints.
html_tags
non_autolinks
propagate_doc_cfg
strip_hidden
strip_priv_imports
strip_private
stripper
unindent_comments

Structs

ConditionalPass	In a list of passes, a pass that may or may not need to be run depending on options.
Pass	A single pass over the cleaned documentation.

Enums

Condition	How to decide whether to run a conditional pass.
DefaultPassOption	A shorthand way to refer to which set of passes to use, based on the presence of --no-defaults and --show-coverage.

Constants

COVERAGE_PASSES	The list of default passes run when --doc-coverage is passed to rustdoc.
DEFAULT_PASSES	The list of passes run by default.
PASSES	The full list of passes.

Functions

defaults	Returns the given default set of passes.
find_pass	If the given name matches a known pass, returns its information.
source_span_for_markdown_range	Attempts to match a range of bytes from parsed markdown to a Span in the source code.
span_of_attrs	Returns a span encompassing all the given attributes.