Module rustdoc::passes

Expand description

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

Modules

Detects links that are not linkified, e.g., in Markdown such as Go to https://example.com/. Suggests wrapping the link with angle brackets: Go to <https://example.com/>. to linkify it.

calculate_doc_coverage 🔒

Calculates information used for the –show-coverage flag.

check_code_block_syntax 🔒

Validates syntax inside Rust code blocks (```rust).

check_doc_test_visibility 🔒

Looks for items missing (or incorrectly having) doctests.

collect_intra_doc_links 🔒

This module implements RFC 1946: Intra-rustdoc-links

collect_trait_impls 🔒

Collects trait impls for each item in the crate. For example, if a crate defines a struct that implements a trait, this pass will note that the struct implements that trait.

html_tags 🔒

Detects invalid HTML (like an unclosed <span>) in doc comments.

propagate_doc_cfg 🔒

Propagates #[doc(cfg(...))] to child items.

strip_hidden 🔒

Strip all doc(hidden) items from the output.

strip_priv_imports 🔒

Strips all private import statements (use, extern crate) from a crate.

strip_private 🔒

Strip all private items from the output. Additionally implies strip_priv_imports. Basically, the goal is to remove items that are not relevant for public documentation.

stripper 🔒

A collection of utility functions for the strip_* passes.