| commit | ed82b2c0b01e9a2360f10c63c34a0651a5c95c50 | [log] [tgz] |
|---|---|---|
| author | Bob Badour <[email protected]> | Thu Nov 10 22:24:54 2022 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Thu Nov 10 22:24:54 2022 +0000 |
| tree | 174aa48b8917d398309920f3f7490feea580379b | |
| parent | c7ae1b6866d175523a0ac33db2bcefef9e4b7d47 [diff] | |
| parent | d05e26903e8f0398db6cc90df4300f7bc727c53c [diff] |
[LSC] Add LOCAL_LICENSE_KINDS to external/rust/crates/document-features am: 4272e46aaf am: 214e14c815 am: d05e26903e Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/2297942 Change-Id: I06dcd5c6c0643d3c3e9d96abfe55f249d8e069a8 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