doku 0.21.1

A framework for documenting Rust data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use crate::prelude::*;

#[derive(Document)]
struct Ty {
    /// Comment for f1
    #[doku(example = "f1-value")]
    f1: String,

    /// Comment for f2
    #[doku(example = "f2-value")]
    f2: Option<String>,

    /// Comment for f3
    #[doku(example = "f3-value")]
    f3: Option<NestedStringA>,

    /// Comment for f4
    #[doku(example = "f4-value")]
    f4: Option<NestedStringB>,

    /// Comment for f5
    #[doku(example = "f5-value")]
    f5: Option<NestedStringC>,

    /// Comment for f6
    #[doku(example = "f6-value")]
    f6: Option<Option<Option<String>>>,

    /// Comment for f7
    f7: NestedStringD,
}

#[derive(Document)]
struct NestedStringA(String);

#[derive(Document)]
struct NestedStringB(NestedStringA);

#[derive(Document)]
#[doku(transparent)]
struct NestedStringC {
    value: NestedStringB,
}

struct NestedStringD;

impl doku::Document for NestedStringD {
    fn ty() -> doku::Type {
        doku::Type {
            example: Some(doku::Example::Simple("f7-value")),
            ..String::ty()
        }
    }
}

printer_test! {
    "output.json" => to_json(Ty),
    "output.without-comma.json" => to_json_without_comma(Ty),
    "output.without-key-quotes.json" => to_json_without_key_quotes(Ty),
    "output.toml" => to_toml(Ty),
}