| commit | eb005c010f0be584e825993c282bcb08287feb92 | [log] [tgz] |
|---|---|---|
| author | Jeff Vander Stoep <[email protected]> | Thu Feb 08 08:09:26 2024 +0100 |
| committer | Jeff Vander Stoep <[email protected]> | Thu Feb 08 08:09:27 2024 +0100 |
| tree | a368009a1a38e5ff9feff8a33f59d8e6d214f194 | |
| parent | 714b322ba434478ab5dcec86a519ffea53cc3cfa [diff] |
Upgrade document-features to 0.2.8 This project was upgraded with external_updater. Usage: tools/external_updater/updater.sh update external/rust/crates/document-features For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md Test: TreeHugger Change-Id: I1ed921aa265598b26cc9d63d6372b090b9d022e1
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