Crates.io | doc-comment |
lib.rs | doc-comment |
version | 0.4.1 |
source | src |
created_at | 2018-03-29 08:35:21.939899 |
updated_at | 2020-07-01 19:18:24.882328 |
description | Macro to generate doc comments |
homepage | |
repository | https://github.com/GuillaumeGomez/doc-comment |
max_upload_size | |
id | 58042 |
size | 20,516 |
Write doc comments from macros.
extern crate doc_comment;
// If you want to test examples in your README file.
doc_comment::doctest!("../README.md");
// If you want to "name" your tests.
doc_comment::doctest!("../README.md", readme);
// If you want to test your README file ONLY on "cargo test":
#[cfg(doctest)]
doc_comment::doctest!("../README.md");
// If you want to document an item:
#[doc_comment::doc_comment("fooo", "or not foo")]
pub struct Foo {
#[doc_comment("a field!")]
field: i32,
}
From the version 0.4
, this crate will use proc-macro
instead of macros
, meaning that the minimum rust version will also greatly increase. If you don't want the proc-macro
then use the 0.3.*
versions!
For more information, take a look at the documentation.