| commit | cf4af946c7cf89f7f3876ba77667e9051dde8fe7 | [log] [tgz] |
|---|---|---|
| author | James Farrell <[email protected]> | Tue Aug 27 03:51:22 2024 +0000 |
| committer | Automerger Merge Worker <[email protected]> | Tue Aug 27 03:51:22 2024 +0000 |
| tree | 070d3ab7f54ff6210972e84cb2f6eed9f04099a9 | |
| parent | fddf27365f2e0f4fe9e9bb308a6cbfe32c42798a [diff] | |
| parent | f0fced39ded961b944f42090f4c64da60fc729ac [diff] |
Migrate 25 crates to monorepo. am: f0fced39de Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/document-features/+/3243661 Change-Id: Ic779c8e2aba02b10b14fcba3a555e31aa6410ca6 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