[−][src]Module rustdoc::passes

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

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.