mirror of
https://git.proxmox.com/git/rustc
synced 2025-08-14 18:05:29 +00:00
.. | ||
src | ||
.cargo-checksum.json | ||
build.rs | ||
Cargo.toml | ||
LICENSE | ||
README.md |
doc-comment

Write doc comments from macros.
Usage example
// Of course, we need to import the `doc_comment` macro:
#[macro_use]
extern crate doc_comment;
// If you want to test examples in your README file.
doctest!("../README.md");
// If you want to test your README file ONLY on "cargo test":
#[cfg(doctest)]
doctest!("../README.md");
// If you want to document an item:
doc_comment!(concat!("fooo", "or not foo"), pub struct Foo {});
For more information, take a look at the documentation.