commit | c2b25bda527f142a7c5acd8a46b8eb4ea827d12f | [log] [tgz] |
---|---|---|
author | James Farrell <jamesfarrell@google.com> | Wed May 08 21:48:29 2024 +0000 |
committer | James Farrell <jamesfarrell@google.com> | Wed May 08 21:48:29 2024 +0000 |
tree | 3ccd035f8d02666edd7776476ca4ece33bd8238f | |
parent | 0b7f3d065417a86ea97b1d11327dbe94b66cdca6 [diff] |
Update Android.bp by running cargo_embargo Test: ran cargo_embargo Change-Id: I74b029b4a0019c9e90abc788b0bce333df934a0a
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