| commit | 960d7d08d33b09bdac278dd21c552e2e3a7df9b8 | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Tue May 21 14:37:54 2024 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Tue May 21 14:37:54 2024 +0000 |
| tree | c9bd56e43ebfc1397609709f1690d1ee829007a7 | |
| parent | 8393b3ca1e8d1aa9b3443a73c814b1298eed2738 [diff] | |
| parent | 2ffc66675f631408ba23d42ff4800fcec830f0fe [diff] |
Update Android.bp by running cargo_embargo am: 2ffc66675f Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/3095557 Change-Id: I174e230d5d9b55d5ccc0dd97ded0cb5eb37884d3 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