MISSING_DOCS in rustc_lint::builtin - Rust
Description: The `missing_docs` lint detects missing documentation for public items.

Skip to main content

## MISSING_DOCS

# Static MISSING_DOCS

Source

    pub static MISSING_DOCS: &Lint

Expand description

The `missing_docs` lint detects missing documentation for public items.

#### §Example

ⓘ

    #![deny(missing_docs)]
    pub fn foo() {}

{{produces}}

#### §Explanation

This lint is intended to ensure that a library is well-documented. Items without documentation can be difficult for users to understand how to use properly.

This lint is “allow” by default because it can be noisy, and not all projects may want to enforce everything to be documented.