Rust Documentation Documentation Lints


To ensure that all possible items are documented, you can use the missing_docs link to receive warnings/errors from the compiler. To receive warnings library-wide, place this attribute in your file:


You can also receive errors for missing documentation with this lint:


By default, missing_docs are allowed, but you can explicitly allow them with this attribute:


This may be useful to place in one module to allow missing documentation for one module, but deny it in all other files.