UNUSED_DOC_COMMENTS in rustc_lint_defs::builtin - Rust
Description: The `unused_doc_comments` lint detects doc comments that aren’t used by `rustdoc`.

Skip to main content

## UNUSED_DOC_COMMENTS

# Static UNUSED_DOC_COMMENTS

Source

    pub static UNUSED_DOC_COMMENTS: &Lint

Expand description

The `unused_doc_comments` lint detects doc comments that aren’t used by `rustdoc`.

#### §Example

    /// docs for x
    let x = 12;

{{produces}}

#### §Explanation

`rustdoc` does not use doc comments in all positions, and so the doc comment will be ignored. Try changing it to a normal comment with `//` to avoid the warning.