tag | ca88daf85841f5549eb0d2d2a046807e76fe302b | |
---|---|---|
tagger | The Android Open Source Project <initial-contribution@android.com> | Tue May 07 10:57:46 2024 -0700 |
object | cd7014187cf641b0000069cd3a0557692853052f |
Android 14.0.0 release 36
commit | cd7014187cf641b0000069cd3a0557692853052f | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Tue Nov 21 00:11:11 2023 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Tue Nov 21 00:11:11 2023 +0000 |
tree | a08b868f77a3c24aeab3777c24186bd6fe990cfc | |
parent | 2cab78f14624ddbdeb8151512943b844e0b6592e [diff] | |
parent | e5601e64f912c0e4f150ba07b671543b41338dac [diff] |
Snap for 11124398 from e5601e64f912c0e4f150ba07b671543b41338dac to 24Q1-release Change-Id: Ie8dab0b4791a034cf8e7864519730ec52065346b
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