bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rustdoc: Prune undocumented return values

Browse source
This commit is contained in:
Brian Anderson 2012-01-23 16:03:15 -08:00
parent a7d3544d10
commit fa3368bc71
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/rustdoc/prune_undoc_pass.rs
View file

@ -53,6 +53,14 @@ fn fold_fn(
} else {
none
}
},
return: {
ty: if option::is_some(doc.return.desc) {
doc.return.ty
} else {
none
}
with doc.return
}
with *doc
};
@ -85,6 +93,17 @@ fn should_not_elide_fns_with_documented_arguments() {
assert vec::is_not_empty(*doc.topmod.fns);
}
#[test]
fn should_elide_undocumented_return_values() {
let source = "#[doc = \"fonz\"] fn a() -> int { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = tystr_pass::mk_pass()(srv, doc);
let doc = attr_pass::mk_pass()(srv, doc);
let doc = run(srv, doc);
assert doc.topmod.fns[0].return.ty == none;
}
fn fold_modlist(
fold: fold::fold<ctxt>,
list: doc::modlist