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

use crate::*;

/// Determines the comments style.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct CommentsStyle {
    /// String to use as comment separator
    ///
    /// ```
    /// use doku::Document;
    ///
    /// #[derive(Document)]
    /// struct Person {
    ///     /// First name
    ///     name: String,
    /// }
    ///
    /// let fmt = doku::json::Formatting {
    ///     comments_style: doku::json::CommentsStyle { separator: "#".to_owned() },
    ///     ..Default::default()
    /// };
    ///
    /// let doc = doku::to_json_fmt::<Person>(&fmt);
    ///
    /// doku::assert_doc!(r#"
    ///   {
    ///     ## First name
    ///     "name": "string"
    ///   }
    /// "#, doc);
    /// ```
    pub separator: String,
}

impl Default for CommentsStyle {
    fn default() -> Self {
        Self {
            separator: "//".to_owned(),
        }
    }
}