Contains information about “passes”, used to modify crate information during the documentation process.
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.
Calculates information used for the –show-coverage flag.
Validates syntax inside Rust code blocks (```rust).
Looks for items missing (or incorrectly having) doctests.
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.
Detects invalid HTML (like an unclosed
<span>) in doc comments.
Strip all doc(hidden) items from the output.
Strips all private import statements (use, extern crate) from a crate.
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.
A collection of utility functions for the
Removes excess indentation on comments in order for the Markdown to be parsed correctly. This is necessary because the convention for writing documentation is to provide a space between the /// or //! marker and the doc text, but Markdown is whitespace-sensitive. For example, a block of text with four-space indentation is parsed as a code block, so if we didn’t unindent comments, these list items
In a list of passes, a pass that may or may not need to be run depending on options.
A single pass over the cleaned documentation.
How to decide whether to run a conditional pass.
The list of default passes run when
--doc-coverage is passed to rustdoc.
The list of passes run by default.
The full list of passes.