| commit | 1cb0e3eed4fbf19a8ca215bc05294236c77be691 | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <[email protected]> | Sat May 11 01:12:15 2024 +0000 |
| committer | Android Build Coastguard Worker <[email protected]> | Sat May 11 01:12:15 2024 +0000 |
| tree | 3ccd035f8d02666edd7776476ca4ece33bd8238f | |
| parent | 3273e01c1c9a18445fff8a425d15008cc2343a29 [diff] | |
| parent | 406f2e92d85b4f1537a87fafaff8b8a39394c940 [diff] |
Snap for 11828632 from 406f2e92d85b4f1537a87fafaff8b8a39394c940 to 24Q3-release Change-Id: I56b8067089ac70df3c4325dc42a69021b77b4533
This crate provides a macro that extracts documentation comments from Cargo.toml
To use this crate, add #![doc = document_features::document_features!()] in your crate documentation. The document_features!() macro reads your Cargo.toml file, extracts feature comments and generates a markdown string for your documentation.
Use ## and #! comments in your Cargo.toml to document features, for example:
[dependencies] document-features = "0.2" ## ... [features] ## The foo feature enables the `foo` functions foo = [] ## The bar feature enables the [`bar`] module bar = [] #! ### Experimental features #! The following features are experimental ## Activate the fusion reactor fusion = []
These comments keep the feature definition and documentation next to each other, and they are then rendered into your crate documentation.
Check out the documentation for more details.
Contributions are welcome. We accept pull requests and bug reports.
MIT OR Apache-2.0