| commit | fddf27365f2e0f4fe9e9bb308a6cbfe32c42798a | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Wed Aug 07 15:32:07 2024 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Wed Aug 07 15:32:07 2024 +0000 |
| tree | f06dd87c779ec984219b360479e3528d8868dd42 | |
| parent | 55571df661fc69798dd97b1d9359821a380da72b [diff] | |
| parent | 9ba99f29c1baaccb37ceea0b0d40f74925e8503a [diff] |
Update Android.bp by running cargo_embargo am: 9ba99f29c1 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/3209011 Change-Id: I2c68841abcd3165f3d97ac9223fc70d5ab2f9a66 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