1 use rustc_span::symbol::sym;
5 use crate::clean::{Item, ItemIdSet, NestedAttributesExt};
6 use crate::core::DocContext;
7 use crate::fold::{strip_item, DocFolder};
8 use crate::passes::{ImplStripper, Pass};
10 crate const STRIP_HIDDEN: Pass = Pass {
13 description: "strips all `#[doc(hidden)]` items from the output",
16 /// Strip items marked `#[doc(hidden)]`
17 crate fn strip_hidden(krate: clean::Crate, _: &mut DocContext<'_>) -> clean::Crate {
18 let mut retained = ItemIdSet::default();
20 // strip all #[doc(hidden)] items
22 let mut stripper = Stripper { retained: &mut retained, update_retained: true };
23 stripper.fold_crate(krate)
26 // strip all impls referencing stripped items
27 let mut stripper = ImplStripper { retained: &retained };
28 stripper.fold_crate(krate)
32 retained: &'a mut ItemIdSet,
33 update_retained: bool,
36 impl<'a> DocFolder for Stripper<'a> {
37 fn fold_item(&mut self, i: Item) -> Option<Item> {
38 if i.attrs.lists(sym::doc).has_word(sym::hidden) {
39 debug!("strip_hidden: stripping {:?} {:?}", i.type_(), i.name);
40 // use a dedicated hidden item for given item type if any
42 clean::StructFieldItem(..) | clean::ModuleItem(..) => {
43 // We need to recurse into stripped modules to
44 // strip things like impl methods but when doing so
45 // we must not add any items to the `retained` set.
46 let old = mem::replace(&mut self.update_retained, false);
47 let ret = strip_item(self.fold_item_recur(i));
48 self.update_retained = old;
54 if self.update_retained {
55 self.retained.insert(i.def_id);
58 Some(self.fold_item_recur(i))