| commit | f0fced39ded961b944f42090f4c64da60fc729ac | [log] [tgz] |
|---|---|---|
| author | James Farrell <jamesfarrell@google.com> | Mon Aug 26 20:42:38 2024 +0000 |
| committer | James Farrell <jamesfarrell@google.com> | Mon Aug 26 20:42:38 2024 +0000 |
| tree | 070d3ab7f54ff6210972e84cb2f6eed9f04099a9 | |
| parent | 9ba99f29c1baaccb37ceea0b0d40f74925e8503a [diff] |
Migrate 25 crates to monorepo. combine command-fds const-oid coset crc32fast criterion criterion-plot crossbeam-channel crossbeam-deque crossbeam-epoch crossbeam-queue crossbeam-utils darling_core darling_macro dashmap data-encoding der der_derive derive_arbitrary displaydoc document-features downcast-rs drm either enumn Bug: 339424309 Test: treehugger Change-Id: I7ad0475ec50141237c60bcc8a59cf8c063fe5e3c
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