Skip to content

rustdoc: Make strip_hidden use a dedicated hidden item if any. #13827

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 1 commit into from
Apr 29, 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
17 changes: 16 additions & 1 deletion src/librustdoc/clean.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,21 @@ impl Item {
return None;
}

pub fn is_hidden_from_doc(&self) -> bool {
match self.doc_list() {
Some(ref l) => {
for innerattr in l.iter() {
match *innerattr {
Word(ref s) if "hidden" == *s => return true,
_ => (),
}
}
},
None => ()
}
return false;
}

pub fn is_mod(&self) -> bool {
match self.inner { ModuleItem(..) => true, _ => false }
}
Expand Down Expand Up @@ -736,7 +751,7 @@ impl Clean<Type> for ast::Ty {

#[deriving(Clone, Encodable, Decodable)]
pub enum StructField {
HiddenStructField,
HiddenStructField, // inserted later by strip passes
TypedStructField(Type),
}

Expand Down
31 changes: 16 additions & 15 deletions src/librustdoc/passes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,24 @@ pub fn strip_hidden(krate: clean::Crate) -> plugins::PluginResult {
};
impl<'a> fold::DocFolder for Stripper<'a> {
fn fold_item(&mut self, i: Item) -> Option<Item> {
for attr in i.attrs.iter() {
match attr {
&clean::List(ref x, ref l) if "doc" == *x => {
for innerattr in l.iter() {
match innerattr {
&clean::Word(ref s) if "hidden" == *s => {
debug!("found one in strip_hidden; removing");
self.stripped.insert(i.id);
return None;
},
_ => (),
}
}
},
_ => ()
if i.is_hidden_from_doc() {
debug!("found one in strip_hidden; removing");
self.stripped.insert(i.id);

// use a dedicated hidden item for given item type if any
match i.inner {
clean::StructFieldItem(..) => {
return Some(clean::Item {
inner: clean::StructFieldItem(clean::HiddenStructField),
..i
});
}
_ => {
return None;
}
}
}

self.fold_item_recur(i)
}
}
Expand Down