OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

rustdoc: Prune undocumented modules

Browse Source
This commit is contained in:
Brian Anderson 2012-01-23 15:40:01 -08:00
parent 521e58a3c4
commit e515999324
1 changed files with 58 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/rustdoc/prune_undoc_pass.rs
View File

@ -18,13 +18,28 @@ fn run(
mutable have_docs: true
};
let fold = fold::fold({
fold_mod: fold_mod,
fold_fn: fold_fn,
fold_modlist: fold_modlist,
fold_fnlist: fold_fnlist
with *fold::default_seq_fold(ctxt)
});
fold.fold_crate(fold, doc)
}
fn fold_mod(
fold: fold::fold<ctxt>,
doc: doc::moddoc
) -> doc::moddoc {
let doc = fold::default_seq_fold_mod(fold, doc);
fold.ctxt.have_docs =
doc.brief != none
|| doc.desc != none
|| vec::is_not_empty(*doc.mods)
|| vec::is_not_empty(*doc.fns);
ret doc;
}
fn fold_fn(
fold: fold::fold<ctxt>,
doc: doc::fndoc
@ -36,6 +51,20 @@ fn fold_fn(
ret doc;
}
fn fold_modlist(
fold: fold::fold<ctxt>,
list: doc::modlist
) -> doc::modlist {
doc::modlist(vec::filter_map(*list) {|doc|
let doc = fold_mod(fold, doc);
if fold.ctxt.have_docs {
some(doc)
} else {
none
}
})
}
fn fold_fnlist(
fold: fold::fold<ctxt>,
list: doc::fnlist
@ -52,6 +81,35 @@ fn fold_fnlist(
#[cfg(test)]
mod tests {
#[test]
fn should_elide_undocumented_mods() {
let source = "mod a { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = run(srv, doc);
assert vec::is_empty(*doc.topmod.mods);
}
#[test]
fn should_not_elide_undocument_mods_with_documented_mods() {
let source = "mod a { #[doc = \"b\"] mod b { } }";
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.mods);
}
#[test]
fn should_not_elide_undocument_mods_with_documented_fns() {
let source = "mod a { #[doc = \"b\"] fn b() { } }";
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.mods);
}
#[test]
fn should_elide_undocumented_fns() {
let source = "fn a() { }";