69 lines
1.9 KiB
Rust
69 lines
1.9 KiB
Rust
#[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 {
|
|
desc_pass::mk_pass(str::trim)
|
|
}
|
|
|
|
#[test]
|
|
fn should_trim_mod() {
|
|
let doc = test::mk_doc("#[doc(brief = \"\nbrief\n\", \
|
|
desc = \"\ndesc\n\")] \
|
|
mod m { }");
|
|
assert doc.topmod.mods()[0].brief() == some("brief");
|
|
assert doc.topmod.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.topmod.consts()[0].brief() == some("brief");
|
|
assert doc.topmod.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.topmod.fns()[0].brief() == some("brief");
|
|
assert doc.topmod.fns()[0].desc() == some("desc");
|
|
}
|
|
|
|
#[test]
|
|
fn should_trim_args() {
|
|
let doc = test::mk_doc("#[doc(args(a = \"\na\n\"))] fn a(a: int) { }");
|
|
assert doc.topmod.fns()[0].args[0].desc == some("a");
|
|
}
|
|
|
|
#[test]
|
|
fn should_trim_ret() {
|
|
let doc = test::mk_doc("#[doc(return = \"\na\n\")] fn a() -> int { }");
|
|
assert doc.topmod.fns()[0].return.desc == some("a");
|
|
}
|
|
|
|
#[test]
|
|
fn should_trim_failure_conditions() {
|
|
let doc = test::mk_doc("#[doc(failure = \"\na\n\")] fn a() -> int { }");
|
|
assert doc.topmod.fns()[0].failure == some("a");
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
fn mk_doc(source: str) -> doc::cratedoc {
|
|
let srv = astsrv::from_str(source);
|
|
let doc = extract::from_srv(srv, "");
|
|
let doc = attr_pass::mk_pass()(srv, doc);
|
|
mk_pass()(srv, doc)
|
|
}
|
|
} |