| commit | 717dcecf7ca5d8629d3712ebc137c3050ca7b89a | [log] [tgz] |
|---|---|---|
| author | Android Build Coastguard Worker <[email protected]> | Sat Jul 08 04:31:56 2023 +0000 |
| committer | Android Build Coastguard Worker <[email protected]> | Sat Jul 08 04:31:56 2023 +0000 |
| tree | 7a26fe7060121f06633afbf29cad40dbc58ae5e2 | |
| parent | 4b434a99baf6d7d1ec9617aa46a87a303e03a646 [diff] | |
| parent | 167c1787901502ab8b5fe3d4cd1641c0022232b3 [diff] |
Snap for 10460766 from 167c1787901502ab8b5fe3d4cd1641c0022232b3 to mainline-healthfitness-release Change-Id: I3fa4a67ca9f3bb6749aa23b394d606f415fd8859
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