| commit | 406f2e92d85b4f1537a87fafaff8b8a39394c940 | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Thu May 09 20:27:14 2024 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Thu May 09 20:27:14 2024 +0000 |
| tree | 3ccd035f8d02666edd7776476ca4ece33bd8238f | |
| parent | 6d13ad4dbf298f849bf73aea3642839cd843670d [diff] | |
| parent | 8393b3ca1e8d1aa9b3443a73c814b1298eed2738 [diff] |
Update Android.bp by running cargo_embargo am: c2b25bda52 am: 8393b3ca1e Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/3080426 Change-Id: I4a5caeda35f2074a60f1f0637cf8016be58f78c0 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