doctor 0.3.4

Flexible low level parser for Javadoc-style doc comments: Javadoc, JSDoc, TSDoc, etc.
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

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct DocComment<'a> {
    #[cfg_attr(feature = "serde", serde(borrow))]
    pub description: Option<Description<'a>>,
    pub block_tags: Vec<BlockTag<'a>>,
}

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Description<'a> {
    #[cfg_attr(feature = "serde", serde(borrow))]
    pub body_items: Vec<BodyItem<'a>>,
}

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct BlockTag<'a> {
    pub name: &'a str,
    pub body_items: Vec<BodyItem<'a>>,
}

#[derive(Clone, Debug, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum BodyItem<'a> {
    TextSegment(&'a str),
    InlineTag(InlineTag<'a>),
}

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct InlineTag<'a> {
    pub name: &'a str,
    pub body_lines: Vec<&'a str>,
}

#[cfg(test)]
mod tests {
    use core::fmt::Debug;
    #[cfg(feature = "serde")]
    use serde::{Deserialize, Serialize};
    use std::hash::Hash;

    use super::*;

    fn assert_default<T: Default>() {}
    fn assert_clone<T: Clone>() {}
    fn assert_debug<T: Debug>() {}
    fn assert_hash<T: Hash>() {}
    fn assert_sync_send<T: Sync + Send>() {}

    #[cfg(feature = "serde")]
    fn assert_serde<'de, T: Serialize + Deserialize<'de>>() {}

    #[test]
    fn test_doc_comment_implement_common_traits() {
        assert_default::<DocComment>();
        assert_clone::<DocComment>();
        assert_debug::<DocComment>();
        assert_hash::<DocComment>();
        assert_sync_send::<DocComment>();

        #[cfg(feature = "serde")]
        assert_serde::<DocComment>()
    }
}