documented

Derive and attribute macros for accessing your type's documentation at runtime

• crates.io
• docs.rs

Quick start

use documented::{Documented, DocumentedFields, DocumentedVariants, docs_const};

/// Trying is the first step to failure.
#[derive(Documented, DocumentedFields, DocumentedVariants)]
#[docs_const]
enum AlwaysPlay {
    /// And Kb8.
    #[allow(dead_code)]
    Kb1,
    /// But only if you are white.
    F6,
}

// Documented
assert_eq!(AlwaysPlay::DOCS, "Trying is the first step to failure.");

// DocumentedFields
assert_eq!(
    AlwaysPlay::FIELD_DOCS,
    ["And Kb8.", "But only if you are white."]
);
assert_eq!(AlwaysPlay::get_field_docs("Kb1"), Ok("And Kb8."));

// DocumentedVariants
assert_eq!(
    AlwaysPlay::F6.get_variant_docs(),
    "But only if you are white."
);

// docs_const
assert_eq!(ALWAYS_PLAY_DOCS, "Trying is the first step to failure.");