| commit | 8a949575620c727492899ba64b7b3a65b3931c76 | [log] [tgz] |
|---|---|---|
| author | James Farrell <jamesfarrell@google.com> | Tue May 21 15:04:13 2024 +0000 |
| committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Tue May 21 15:04:13 2024 +0000 |
| tree | c9bd56e43ebfc1397609709f1690d1ee829007a7 | |
| parent | 406f2e92d85b4f1537a87fafaff8b8a39394c940 [diff] | |
| parent | 960d7d08d33b09bdac278dd21c552e2e3a7df9b8 [diff] |
Update Android.bp by running cargo_embargo am: 2ffc66675f am: 960d7d08d3 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/3095557 Change-Id: Ieedbc18978a64cb50d9915ea5ba71d0a4134a607 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
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