mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rustdoc: Don't prune functions with documented failure conditions

Browse Source
This commit is contained in:
Brian Anderson 2012-01-24 18:08:48 -08:00
parent efc067952d
commit a66bff6e81
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/rustdoc/prune_undoc_pass.rs
View File

@ -71,7 +71,8 @@ fn fold_fn(
doc.brief != none
|| doc.desc != none
|| have_arg_docs
|| doc.return.desc != none;
|| doc.return.desc != none
|| doc.failure != none;
ret doc;
}
@ -106,6 +107,16 @@ fn should_elide_undocumented_return_values() {
assert doc.topmod.fns[0].return.ty == none;
}
#[test]
fn should_not_elide_fns_with_documented_failure_conditions() {
let source = "#[doc(failure = \"yup\")] fn a() { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = attr_pass::mk_pass()(srv, doc);
let doc = run(srv, doc);
assert vec::is_not_empty(*doc.topmod.fns);
}
fn fold_modlist(
fold: fold::fold<ctxt>,
list: doc::modlist