Skip to content

Assorted rustdoc fixes #11461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 11, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mk/docs.mk
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ $(eval $(call libdoc,std,$(STDLIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,native,$(LIBNATIVE_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,green,$(LIBGREEN_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,rustuv,$(LIBRUSTUV_CRATE),$(CFG_BUILD)))

$(eval $(call compiledoc,rustc,$(COMPILER_CRATE),$(CFG_BUILD)))
$(eval $(call compiledoc,syntax,$(LIBSYNTAX_CRATE),$(CFG_BUILD)))
Expand Down
27 changes: 22 additions & 5 deletions src/librustdoc/html/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ pub struct Cache {
priv stack: ~[~str],
priv parent_stack: ~[ast::NodeId],
priv search_index: ~[IndexItem],
priv privmod: bool,
}

/// Helper struct to render all source code to HTML pages
Expand Down Expand Up @@ -241,6 +242,7 @@ pub fn run(mut crate: clean::Crate, dst: Path) {
parent_stack: ~[],
search_index: ~[],
extern_locations: HashMap::new(),
privmod: false,
};
cache.stack.push(crate.name.clone());
crate = cache.fold_crate(crate);
Expand Down Expand Up @@ -455,6 +457,16 @@ impl<'a> SourceCollector<'a> {

impl DocFolder for Cache {
fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
// If this is a private module, we don't want it in the search index.
let orig_privmod = match item.inner {
clean::ModuleItem(..) => {
let prev = self.privmod;
self.privmod = prev || item.visibility != Some(ast::Public);
prev
}
_ => self.privmod,
};

// Register any generics to their corresponding string. This is used
// when pretty-printing types
match item.inner {
Expand Down Expand Up @@ -530,7 +542,7 @@ impl DocFolder for Cache {
_ => Some((None, self.stack.as_slice()))
};
match parent {
Some((parent, path)) => {
Some((parent, path)) if !self.privmod => {
self.search_index.push(IndexItem {
ty: shortty(&item),
name: s.to_owned(),
Expand All @@ -539,7 +551,7 @@ impl DocFolder for Cache {
parent: parent,
});
}
None => {}
Some(..) | None => {}
}
}
None => {}
Expand Down Expand Up @@ -612,8 +624,12 @@ impl DocFolder for Cache {
// Private modules may survive the strip-private pass if
// they contain impls for public types, but those will get
// stripped here
clean::Item { inner: clean::ModuleItem(ref m), .. }
if m.items.len() == 0 => None,
clean::Item { inner: clean::ModuleItem(ref m),
visibility, .. }
if (m.items.len() == 0 &&
item.doc_value().is_none()) ||
visibility != Some(ast::Public) => None,

i => Some(i),
}
}
Expand All @@ -622,6 +638,7 @@ impl DocFolder for Cache {

if pushed { self.stack.pop(); }
if parent_pushed { self.parent_stack.pop(); }
self.privmod = orig_privmod;
return ret;
}
}
Expand Down Expand Up @@ -1186,7 +1203,7 @@ fn item_struct(w: &mut Writer, it: &clean::Item, s: &clean::Struct) {

document(w, it);
match s.struct_type {
doctree::Plain => {
doctree::Plain if s.fields.len() > 0 => {
write!(w, "<h2 class='fields'>Fields</h2>\n<table>");
for field in s.fields.iter() {
write!(w, "<tr><td id='structfield.{name}'>\
Expand Down
4 changes: 4 additions & 0 deletions src/librustdoc/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ pub fn opts() -> ~[groups::OptGroup] {
use extra::getopts::groups::*;
~[
optflag("h", "help", "show this help message"),
optflag("", "version", "print rustdoc's version"),
optopt("r", "input-format", "the input type of the specified file",
"[rust|json]"),
optopt("w", "output-format", "the output type to write",
Expand Down Expand Up @@ -119,6 +120,9 @@ pub fn main_args(args: &[~str]) -> int {
if matches.opt_present("h") || matches.opt_present("help") {
usage(args[0]);
return 0;
} else if matches.opt_present("version") {
rustc::version(args[0]);
return 0;
}

if matches.free.len() == 0 {
Expand Down
4 changes: 3 additions & 1 deletion src/librustdoc/passes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,9 @@ impl<'a> fold::DocFolder for Stripper<'a> {
Some(i) => {
match i.inner {
// emptied modules/impls have no need to exist
clean::ModuleItem(ref m) if m.items.len() == 0 => None,
clean::ModuleItem(ref m)
if m.items.len() == 0 &&
i.doc_value().is_none() => None,
clean::ImplItem(ref i) if i.methods.len() == 0 => None,
_ => {
self.retained.insert(i.id);
Expand Down