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

---
source: snipdoc/src/parser/injector.rs
expression: injector.run(&snippet_refs)
---
Ok(
    InjectSummary {
        content: "# Snipdoc[NEW_LINE][NEW_LINE]<!-- <snip id=\"installation\" inject_from=\"code\"> -->[NEW_LINE]$ cargo install snipdoc[NEW_LINE]$ snipdoc --version[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"inject_from_yaml\" inject_from=\"yaml\"> -->[NEW_LINE]inject_from_yaml[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"inject_from_yaml\" inject_from=\"code\"> -->[NEW_LINE]# Skip injection, `inject_from_yaml` snippet id not exists in code[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"inject_from_yaml\" inject_from=\"any\"> -->[NEW_LINE]inject_from_yaml[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"description\" inject_from=\"code\" add_prefix=\"//! \"> -->[NEW_LINE]//! snipdoc[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"description\" inject_from=\"code\" strip_prefix=\"snip\"> -->[NEW_LINE]doc[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"description\" inject_from=\"code\"[NEW_LINE]template=\"```sh\[NEW_LINE]{snippet}\[NEW_LINE]```\"> --> ```sh[NEW_LINE]snipdoc[NEW_LINE]```[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"description\" inject_from=\"code\"> -->[NEW_LINE]snipdoc[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]<!-- <snip id=\"not-found\" inject_from=\"code\"> -->[NEW_LINE]not-found[NEW_LINE]<!-- </snip> -->[NEW_LINE][NEW_LINE]",
        actions: [
            Injected {
                snippet_id: "installation",
                content: "$ cargo install snipdoc[NEW_LINE]$ snipdoc --version",
            },
            Injected {
                snippet_id: "inject_from_yaml",
                content: "inject_from_yaml",
            },
            Injected {
                snippet_id: "inject_from_yaml",
                content: "inject_from_yaml",
            },
            Injected {
                snippet_id: "description",
                content: "//! snipdoc",
            },
            Injected {
                snippet_id: "description",
                content: "doc",
            },
            Injected {
                snippet_id: "description",
                content: "```sh[NEW_LINE]snipdoc[NEW_LINE]```",
            },
            Equal {
                snippet_id: "description",
            },
            NotFound {
                snippet_id: "not-found",
                snippet_kind: Code,
            },
        ],
    },
)