Here is the list of the lints provided by `rustdoc`:
-## broken_intra_doc_links
+## `broken_intra_doc_links`
This lint **warns by default**. This lint detects when an [intra-doc link] fails to be resolved. For example:
-[intra-doc link]: linking-to-items-by-name.md
+[intra-doc link]: write-documentation/linking-to-items-by-name.md
```rust
/// I want to link to [`Nonexistent`] but it doesn't exist!
```
-## private_intra_doc_links
+## `private_intra_doc_links`
This lint **warns by default**. This lint detects when [intra-doc links] from public to private items.
For example:
= note: this link resolves only because you passed `--document-private-items`, but will break without
```
-[intra-doc links]: linking-to-items-by-name.html
+[intra-doc links]: write-documentation/linking-to-items-by-name.md
-## missing_docs
+## `missing_docs`
This lint is **allowed by default**. It detects items missing documentation.
For example:
Note that unlike other rustdoc lints, this lint is also available from `rustc` directly.
-## missing_crate_level_docs
+## `missing_crate_level_docs`
This lint is **allowed by default**. It detects if there is no documentation
at the crate root. For example:
get started, without providing overwhelming warnings like `missing_docs`
might.
-## missing_doc_code_examples
+## `missing_doc_code_examples`
This lint is **allowed by default** and is **nightly-only**. It detects when a documentation block
is missing a code example. For example:
pub fn no_code_example() {}
```
-## private_doc_tests
+## `private_doc_tests`
This lint is **allowed by default**. It detects documentation tests when they
are on a private item. For example:
| |___________^
```
-## invalid_codeblock_attributes
+## `invalid_codeblock_attributes`
This lint **warns by default**. It detects code block attributes in
documentation examples that have potentially mis-typed values. For example:
In the example above, the correct form is `should_panic`. This helps detect
typo mistakes for some common attributes.
-## invalid_html_tags
+## `invalid_html_tags`
This lint is **allowed by default** and is **nightly-only**. It detects unclosed
or invalid HTML tags. For example:
warning: 2 warnings emitted
```
-## invalid_rust_codeblocks
+## `invalid_rust_codeblocks`
This lint **warns by default**. It detects Rust code blocks in documentation
examples that are invalid (e.g. empty, not parsable as Rust). For example:
= note: error from rustc: unterminated character literal
```
-## bare_urls
+## `bare_urls`
This lint is **warn-by-default**. It detects URLs which are not links.
For example: