documented
Traits and derive macros for accessing your type's documentation at runtime
Quick start
use documented::{Documented, DocumentedFields, DocumentedVariants, Error};
#[derive(Documented, DocumentedFields, DocumentedVariants)]
enum AlwaysPlay {
Kb1,
F6,
}
assert_eq!(AlwaysPlay::DOCS, "Trying is the first step to failure.");
assert_eq!(
AlwaysPlay::FIELD_DOCS,
[None, Some("But only if you are white.")]
);
assert_eq!(
AlwaysPlay::get_field_docs("F6"),
Ok("But only if you are white.")
);
assert_eq!(
AlwaysPlay::F6.get_variant_docs(),
Ok("But only if you are white.")
);