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

resolve module docs based on inner/outer attributes

Browse Source
This commit is contained in:
QuietMisdreavus 2018-01-08 11:10:50 -06:00 committed by Manish Goregaokar
parent 1a62b17f7d
commit b31bb097f5
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/librustdoc/clean/mod.rs
View File

@ -20,7 +20,7 @@ pub use self::FunctionRetTy::*;
pub use self::Visibility::*;
use syntax::abi::Abi;
use syntax::ast;
use syntax::ast::{self, AttrStyle};
use syntax::attr;
use syntax::codemap::Spanned;
use syntax::feature_gate::UnstableFeatures;
@ -472,11 +472,22 @@ impl Clean<Item> for doctree::Module {
"".to_string()
};
// maintain a stack of mod ids
// we could also pass this down through clean()
// but that might complicate things.
cx.mod_ids.borrow_mut().push(self.id);
let attrs = self.attrs.clean(cx);
// maintain a stack of mod ids, for doc comment path resolution
// but we also need to resolve the module's own docs based on whether its docs were written
// inside or outside the module, so check for that
let attrs = if self.attrs.iter()
.filter(|a| a.check_name("doc"))
.next()
.map_or(true, |a| a.style == AttrStyle::Inner) {
// inner doc comment, use the module's own scope for resolution
cx.mod_ids.borrow_mut().push(self.id);
self.attrs.clean(cx)
} else {
// outer doc comment, use its parent's scope
let attrs = self.attrs.clean(cx);
cx.mod_ids.borrow_mut().push(self.id);
attrs
};
let mut items: Vec<Item> = vec![];
items.extend(self.extern_crates.iter().map(|x| x.clean(cx)));