Static rustc_lint_defs::builtin::INVALID_DOC_ATTRIBUTES

source · 
pub static INVALID_DOC_ATTRIBUTES: &Lint
Expand description

The invalid_doc_attributes lint detects when the #[doc(...)] is misused.

Example

ⓘ
#![deny(warnings)]

pub mod submodule {
    #![doc(test(no_crate_inject))]
}

{{produces}}

Explanation

Previously, incorrect usage of the #[doc(..)] attribute was not being validated. Usually these should be rejected as a hard error, but this lint was introduced to avoid breaking any existing crates which included them.

This is a [future-incompatible] lint to transition this to a hard error in the future. See issue #82730 for more details.