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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use crate::*;

/// Determines whether the document should contain one or two columns.
#[derive(Clone, Debug, Deserialize)]
#[serde(deny_unknown_fields)]
pub enum Layout {
    /// Prints types and comments inline, in a single chunk of text:
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     /// First name
    ///     /// (aka forename)
    ///     fname: String,
    ///
    ///     /// Last name
    ///     /// (aka surname)
    ///     lname: String,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     layout: doku::json::Layout::OneColumn,
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     // First name
    ///     // (aka forename)
    ///     "fname": "string",
    ///     // Last name
    ///     // (aka surname)
    ///     "lname": "string"
    ///   }
    /// "#, doc);
    /// ```
    OneColumn,

    /// Prints types and comments in two separate columns.
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     /// First name
    ///     /// (aka forename)
    ///     fname: String,
    ///
    ///     /// Last name
    ///     /// (aka surname)
    ///     lname: String,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     layout: doku::json::Layout::TwoColumns {
    ///         align: true,
    ///         spacing: 1,
    ///     },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     "fname": "string", // First name
    ///                        // (aka forename)
    ///     "lname": "string"  // Last name
    ///                        // (aka surname)
    ///   }
    /// "#, doc);
    /// ```
    TwoColumns {
        /// Whether the two columns should be aligned or not:
        ///
        /// ```
        /// use doku::Document;
        ///
        /// #[derive(Document)]
        /// struct Person {
        ///     /// First name
        ///     /// (aka forename)
        ///     fname: String,
        ///
        ///     /// Last name
        ///     /// (aka surname)
        ///     lname: String,
        /// }
        ///
        /// let fmt = doku::json::Formatting {
        ///     layout: doku::json::Layout::TwoColumns {
        ///         align: false,
        ///         spacing: 1,
        ///     },
        ///     ..Default::default()
        /// };
        ///
        /// let doc = doku::to_json_fmt::<Person>(&fmt);
        ///
        /// doku::assert_doc!(r#"
        ///   {
        ///     "fname": "string", // First name
        ///                        // (aka forename)
        ///     "lname": "string" // Last name
        ///                       // (aka surname)
        ///   }
        /// "#, doc);
        /// ```
        align: bool,

        /// Size of the horizontal spacing between both columns:
        ///
        /// ```
        /// use doku::Document;
        ///
        /// #[derive(Document)]
        /// struct Person {
        ///     /// First name
        ///     /// (aka forename)
        ///     fname: String,
        ///
        ///     /// Last name
        ///     /// (aka surname)
        ///     lname: String,
        /// }
        ///
        /// let fmt = doku::json::Formatting {
        ///     layout: doku::json::Layout::TwoColumns {
        ///         align: true,
        ///         spacing: 5,
        ///     },
        ///     ..Default::default()
        /// };
        ///
        /// let doc = doku::to_json_fmt::<Person>(&fmt);
        ///
        /// doku::assert_doc!(r#"
        ///   {
        ///     "fname": "string",     // First name
        ///                            // (aka forename)
        ///     "lname": "string"      // Last name
        ///                            // (aka surname)
        ///   }
        /// "#, doc);
        /// ```
        spacing: usize,
    },
}

impl Default for Layout {
    fn default() -> Self {
        Self::OneColumn
    }
}