| commit | 498ca05739897a958c2d21c891e8dc65911a9ded | [log] [tgz] |
|---|---|---|
| author | Wei Li <[email protected]> | Thu Aug 01 15:43:55 2024 -0700 |
| committer | Wei Li <[email protected]> | Thu Aug 01 15:43:55 2024 -0700 |
| tree | b138b7ec9805c7f5185cc735e6774e94b1acc1ce | |
| parent | 960d7d08d33b09bdac278dd21c552e2e3a7df9b8 [diff] |
Cleanup license metadata in external/rust/crates/document-features. Symlink file LICENSE is added in Android codebase and points to file LICENSE-APACHE, so use it in Android.bp. Bug: 346390141 Test: CIs Change-Id: Ie548e55380b1a26ad829a7bc20e7152e4af6372d
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