Expand description

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

Modules

bare_urls 🔒

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.

This module implements RFC 1946: Intra-rustdoc-links

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.

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

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.

stripper 🔒

A collection of utility functions for the strip_* passes.

Structs

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.

Constants

The list of default passes run when --doc-coverage is passed to rustdoc.

The list of passes run by default.

PASSES 🔒

The full list of passes.

Functions

defaults 🔒

Returns the given default set of passes.

Attempts to match a range of bytes from parsed markdown to a Span in the source code.

Returns a span encompassing all the given attributes.