user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Auto merge of #34232 - ollie27:rustdoc_inline, r=alexcrichton

Browse source 
rustdoc: Don't inline #[doc(hidden)] pub use

Currently if a `#[doc(hidden)] pub use` item is inlined the `hidden`
attribute is ignored so the item can appear in the docs. By never inlining
such imports, they can be stripped.

An example in `std` is [`__OsLocalKeyInner`](https://doc.rust-lang.org/nightly/std/thread/struct.__OsLocalKeyInner.html) which clearly should not be documented.
This commit is contained in:
bors 2016-06-14 05:04:38 -07:00 • committed by GitHub
commit 2940eb54bd
4 changed files with 48 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/librustdoc/clean/mod.rs
View file

@ -2389,9 +2389,11 @@ impl Clean<Vec<Item>> for doctree::Import {
// We consider inlining the documentation of `pub use` statements, but we
// forcefully don't inline if this is not public or if the
// #[doc(no_inline)] attribute is present.
// Don't inline doc(hidden) imports so they can be stripped at a later stage.
let denied = self.vis != hir::Public || self.attrs.iter().any(|a| {
&a.name()[..] == "doc" && match a.meta_item_list() {
Some(l) => attr::contains_name(l, "no_inline"),
Some(l) => attr::contains_name(l, "no_inline") ||
attr::contains_name(l, "hidden"),
None => false,
}
});

4
src/librustdoc/visit_ast.rs
View file

@ -245,7 +245,9 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
let def_did = def.def_id();
let use_attrs = tcx.map.attrs(id).clean(self.cx);
let is_no_inline = use_attrs.list("doc").has_word("no_inline");
// Don't inline doc(hidden) imports so they can be stripped at a later stage.
let is_no_inline = use_attrs.list("doc").has_word("no_inline") ||
use_attrs.list("doc").has_word("hidden");
// For cross-crate impl inlining we need to know whether items are
// reachable in documentation - a previously nonreachable item can be