src/rustdoc/trim_pass.rs


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

#[doc = "

Pulls a brief description out of a long description.

If the first paragraph of a long description is short enough then it
is interpreted as the brief description.

"];

export mk_pass;

fn mk_pass() -> pass {
    text_pass::mk_pass("trim", {|s| str::trim(s)})
}

#[test]
fn should_trim_mod() {
    let doc = test::mk_doc("#[doc(brief = \"\nbrief\n\", \
                            desc = \"\ndesc\n\")] \
                            mod m { }");
    assert doc.cratemod().mods()[0].brief() == some("brief");
    assert doc.cratemod().mods()[0].desc() == some("desc");
}

#[test]
fn should_trim_const() {
    let doc = test::mk_doc("#[doc(brief = \"\nbrief\n\", \
                            desc = \"\ndesc\n\")] \
                            const a: bool = true;");
    assert doc.cratemod().consts()[0].brief() == some("brief");
    assert doc.cratemod().consts()[0].desc() == some("desc");
}

#[test]
fn should_trim_fn() {
    let doc = test::mk_doc("#[doc(brief = \"\nbrief\n\", \
                            desc = \"\ndesc\n\")] \
                            fn a() { }");
    assert doc.cratemod().fns()[0].brief() == some("brief");
    assert doc.cratemod().fns()[0].desc() == some("desc");
}

#[cfg(test)]
mod test {
    fn mk_doc(source: str) -> doc::doc {
        astsrv::from_str(source) {|srv|
            let doc = extract::from_srv(srv, "");
            let doc = attr_pass::mk_pass().f(srv, doc);
            mk_pass().f(srv, doc)
        }
    }
}