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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use crate::*;

/// Determines the spacing between fields.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Spacing {
    /// How many lines to use to split scalar fields:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     /// Person's name
    ///     name: String,
    ///     surname: String,
    ///
    ///     /// Person's address
    ///     address: String,
    /// }
    ///
    /// let fmt = doku::toml::Formatting {
    ///     spacing: doku::toml::Spacing {
    ///         lines_between_scalar_fields: 1,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_toml_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   ## Person's name
    ///   name = "string"
    ///
    ///   surname = "string"
    ///
    ///   ## Person's address
    ///   address = "string"
    /// "#, doc);
    /// ```
    pub lines_between_scalar_fields: usize,

    /// How many lines to use before a scalar field's comment:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     /// Person's name
    ///     name: String,
    ///     surname: String,
    ///
    ///     /// Person's address
    ///     address: String,
    /// }
    ///
    /// let fmt = doku::toml::Formatting {
    ///     spacing: doku::toml::Spacing {
    ///         lines_between_scalar_field_comments: 1,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_toml_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   ## Person's name
    ///   name = "string"
    ///   surname = "string"
    ///
    ///   ## Person's address
    ///   address = "string"
    /// "#, doc);
    /// ```
    pub lines_between_scalar_field_comments: usize,

    /// How many lines to use to split tables:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     name: String,
    ///     address: Address,
    /// }
    ///
    /// #[derive(Document)]
    /// struct Address {
    ///     street: String,
    ///     number: u32
    /// }
    ///
    /// let fmt = doku::toml::Formatting {
    ///     spacing: doku::toml::Spacing {
    ///         lines_between_tables: 2,
    ///         ..Default::default()
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_toml_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   name = "string"
    ///
    ///
    ///   [address]
    ///   street = "string"
    ///   number = 123
    /// "#, doc);
    /// ```
    pub lines_between_tables: usize,
}

impl Default for Spacing {
    fn default() -> Self {
        Self {
            lines_between_scalar_fields: 0,
            lines_between_scalar_field_comments: 1,
            lines_between_tables: 1,
        }
    }
}