| commit | 86001b3c86e6e6472d9c71756895905b6e91db65 | [log] [tgz] |
|---|---|---|
| author | Jeff Vander Stoep <[email protected]> | Wed Feb 01 12:51:45 2023 +0100 |
| committer | Jeff Vander Stoep <[email protected]> | Wed Feb 01 12:51:45 2023 +0100 |
| tree | 5dd052176f1219e66527f57d2d4847fd28cbdb5d | |
| parent | 214e14c8151c70940889b2da33ff3256a49bff42 [diff] |
Upgrade document-features to 0.2.7 This project was upgraded with external_updater. Usage: tools/external_updater/updater.sh update rust/crates/document-features For more info, check https://cs.android.com/android/platform/superproject/+/master:tools/external_updater/README.md Test: TreeHugger Change-Id: I48a98dbebcca680a237cf175835c5c94ecc5cb6a
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