| commit | 6e4ed2d92471ad9ba49fba9c650a7bbbf3277b8e | [log] [tgz] |
|---|---|---|
| author | Frederick Mayle <[email protected]> | Sat Nov 05 22:56:03 2022 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Sat Nov 05 22:56:03 2022 +0000 |
| tree | 4f29ef0c0ff7d75f6180ff334e5d61e85c80847e | |
| parent | fc553d80d237e067ca56ac7d74bd378ccdfa9d89 [diff] | |
| parent | 555ca75099f33ac1714eff5e314fe7e31bdf1fb0 [diff] |
Initial import of document-features-0.2.6 am: 555ca75099 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/2287897 Change-Id: I1f6f3c9d50c8039f955244a072a5f0e232726535 Signed-off-by: Automerger Merge Worker <[email protected]>
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