snipdoc 0.1.12

Code Documentation Made Simple
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

---
source: snipdoc/src/parser/collector.rs
expression: collector.run()
---
Ok(
    [
        CollectSnippet {
            id: "description",
            inject_from: Some(
                Code,
            ),
            tag_open: "<snip id=\"description\" inject_from=\"code\"> ",
            tag_close: "<!-- </snip> -->\n",
            snippet: [],
        },
        CollectSnippet {
            id: "installation",
            inject_from: None,
            tag_open: "<snip id=\"installation\"> ",
            tag_close: "<!-- </snip> -->\n",
            snippet: [
                "$ cargo install snipdoc",
                "$ ssnipdoc --version",
            ],
        },
        CollectSnippet {
            id: "no-spaces",
            inject_from: None,
            tag_open: "<snip id=\"no-spaces\">",
            tag_close: "<!--</snip>-->\n",
            snippet: [
                "$ cargo install snipdoc",
                "$ ssnipdoc --version",
            ],
        },
        CollectSnippet {
            id: "double-slash",
            inject_from: None,
            tag_open: "<snip id=\"double-slash\">\n",
            tag_close: "// </snip>\n",
            snippet: [
                "double-slash",
            ],
        },
        CollectSnippet {
            id: "triple-slash",
            inject_from: None,
            tag_open: "<snip id=\"triple-slash\">\n",
            tag_close: "// </snip>\n//",
            snippet: [
                "triple-slash",
                "/// </snip>",
            ],
        },
        CollectSnippet {
            id: "hashtag",
            inject_from: None,
            tag_open: "<snip id=\"hashtag\">\n",
            tag_close: "# </snip>\n",
            snippet: [
                "hashtag",
            ],
        },
        CollectSnippet {
            id: "level-1",
            inject_from: None,
            tag_open: "<snip id=\"level-1\" -->\n",
            tag_close: "</snip> -->\n",
            snippet: [
                "Level 1",
                "// <snip id=\"level-2\">",
                "Level 2",
                "// <snip id=\"level-3\">",
                "Level 3",
                "// </snip>",
                "// </snip>",
            ],
        },
        CollectSnippet {
            id: "level-2",
            inject_from: None,
            tag_open: "<snip id=\"level-2\">\n",
            tag_close: "</snip>\n<!-- ",
            snippet: [
                "Level 2",
                "// <snip id=\"level-3\">",
                "Level 3",
                "// </snip>",
                "// </snip>",
            ],
        },
        CollectSnippet {
            id: "level-3",
            inject_from: None,
            tag_open: "<snip id=\"level-3\">\n",
            tag_close: "// </snip>\n// ",
            snippet: [
                "Level 3",
                "// </snip>",
            ],
        },
    ],
)