Macros
Statics
- The
bare_urls
lint detects when a URL is not a hyperlink. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
broken_intra_doc_links
lint detects failures in resolving intra-doc link targets. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
invalid_codeblock_attributes
lint detects code block attributes in documentation examples that have potentially mis-typed values. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
invalid_html_tags
lint detects invalid HTML tags. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
invalid_rust_codeblocks
lint detects Rust code blocks in documentation examples that are invalid (e.g. empty, not parsable as Rust code). This is arustdoc
only lint, see the documentation in the rustdoc book. - The
missing_crate_level_docs
lint detects if documentation is missing at the crate root. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
missing_doc_code_examples
lint detects publicly-exported items without code samples in their documentation. This is arustdoc
only lint, see the documentation in the rustdoc book. - The
private_doc_tests
lint detects code samples in docs of private items not documented byrustdoc
. This is arustdoc
only lint, see the documentation in the rustdoc book. - This is a subset of
broken_intra_doc_links
that warns when linking from a public item to a private one. This is arustdoc
only lint, see the documentation in the rustdoc book. - This lint is warned by default. It detects explicit links that are same as computed automatic links. This usually means the explicit links is removeable. This is a
rustdoc
only lint, see the documentation in the rustdoc book. - The
unescaped_backticks
lint detects unescaped backticks (`), which usually mean broken inline code. This is arustdoc
only lint, see the documentation in the rustdoc book.
Functions
- This function is used to setup the lint initialization. By default, in rustdoc, everything is “allowed”. Depending if we run in test mode or not, we want some of them to be at their default level. For example, the “INVALID_CODEBLOCK_ATTRIBUTES” lint is activated in both modes.