Skip to content

Commit

Permalink
Don't inline impls from doc(hidden) modules
Browse files Browse the repository at this point in the history
  • Loading branch information
mitaa committed Feb 26, 2016
1 parent c9852e2 commit eae9f46
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 11 deletions.
27 changes: 16 additions & 11 deletions src/librustdoc/clean/inline.rs
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,11 @@ pub fn build_impls(cx: &DocContext, tcx: &ty::ctxt,
match def {
cstore::DlImpl(did) => build_impl(cx, tcx, did, impls),
cstore::DlDef(Def::Mod(did)) => {
// Don't recurse if this is a #[doc(hidden)] module
if load_attrs(cx, tcx, did).iter().any(|a| is_doc_hidden(a)) {
return;
}

for item in tcx.sess.cstore.item_children(did) {
populate_impls(cx, tcx, item.def, impls)
}
Expand Down Expand Up @@ -423,19 +428,19 @@ pub fn build_impl(cx: &DocContext,
deprecation: stability::lookup_deprecation(tcx, did).clean(cx),
def_id: did,
});
}

fn is_doc_hidden(a: &clean::Attribute) -> bool {
match *a {
clean::List(ref name, ref inner) if *name == "doc" => {
inner.iter().any(|a| {
match *a {
clean::Word(ref s) => *s == "hidden",
_ => false,
}
})
}
_ => false
fn is_doc_hidden(a: &clean::Attribute) -> bool {
match *a {
clean::List(ref name, ref inner) if *name == "doc" => {
inner.iter().any(|a| {
match *a {
clean::Word(ref s) => *s == "hidden",
_ => false,
}
})
}
_ => false
}
}

Expand Down
18 changes: 18 additions & 0 deletions src/test/auxiliary/issue-29584.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

pub struct Foo;

#[doc(hidden)]
mod bar {
trait Bar {}

impl Bar for ::Foo {}
}
18 changes: 18 additions & 0 deletions src/test/rustdoc/issue-29584.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// aux-build:issue-29584.rs
// ignore-cross-compile

extern crate issue_29584;

// @has issue_29584/struct.Foo.html
// @!has - 'impl Bar for'
pub use issue_29584::Foo;

0 comments on commit eae9f46

Please sign in to comment.