| commit | aa3f2ba4e4a0790e4510e2b6820eb41dd293d31e | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Sat Feb 04 04:15:47 2023 +0000 |
| committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Sat Feb 04 04:15:47 2023 +0000 |
| tree | 5dd052176f1219e66527f57d2d4847fd28cbdb5d | |
| parent | 4464c090e87863de6e5fa9d25b5cc86f12f73537 [diff] | |
| parent | 6d6982abe5e05fbf5a7581ddb020e756c126420f [diff] |
Snap for 9562441 from 6d6982abe5e05fbf5a7581ddb020e756c126420f to udc-release Change-Id: I21caad6b0e8784447deeaf47ceb5198b580cda2a
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