docparser 0.1.0

A CLI tool to extract Rust doc comments and export them in JSON or WSON format
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

use wson_rs::{WsonValue, WsonMap};
use crate::{DocItem, DocOutput};

pub fn to_wson(doc: &DocOutput) -> WsonValue {
    let mut map = WsonMap::new();

    // module_docs: Array of Strings
    map.insert(
        "module_docs".to_string(),
        WsonValue::Array(doc.module_docs.iter().cloned().map(WsonValue::String).collect()),
    );

    // functions: Array of { name, docs }
    map.insert(
        "functions".to_string(),
        WsonValue::Array(
            doc.functions
                .iter()
                .map(doc_item_to_wson)
                .collect(),
        ),
    );

    // structs: Array of { name, docs }
    map.insert(
        "structs".to_string(),
        WsonValue::Array(
            doc.structs
                .iter()
                .map(doc_item_to_wson)
                .collect(),
        ),
    );

    // enums: Array of { name, docs }
    map.insert(
        "enums".to_string(),
        WsonValue::Array(
            doc.enums
                .iter()
                .map(doc_item_to_wson)
                .collect(),
        ),
    );

    WsonValue::Object(map)
}

fn doc_item_to_wson(item: &DocItem) -> WsonValue {
    let mut map = WsonMap::new();
    map.insert("name".to_string(), WsonValue::String(item.name.clone()));
    map.insert(
        "docs".to_string(),
        WsonValue::Array(item.docs.iter().cloned().map(WsonValue::String).collect()),
    );
    WsonValue::Object(map)
}