diff options
| author | Alex Crichton <alex@alexcrichton.com> | 2015-04-06 16:43:55 -0700 |
|---|---|---|
| committer | Alex Crichton <alex@alexcrichton.com> | 2015-04-07 17:54:34 -0700 |
| commit | fcc89ea5006441350f0275946ff6db84a1118e49 (patch) | |
| tree | 9dc9f854b7ff4aaf76000797d42e22fe144e1ca8 | |
| parent | c47bb7cd50e932a99213e004010e0f262f253446 (diff) | |
| download | rust-fcc89ea5006441350f0275946ff6db84a1118e49.tar.gz rust-fcc89ea5006441350f0275946ff6db84a1118e49.zip | |
rustdoc: Only hide possibly private modules
If an empty public module has no documentation, it shouldn't emit a page that's just a redirect loop to itself! Closes #16265
| -rw-r--r-- | src/librustdoc/html/render.rs | 4 | ||||
| -rw-r--r-- | src/test/rustdoc/issue-16265-1.rs | 18 | ||||
| -rw-r--r-- | src/test/rustdoc/issue-16265-2.rs | 15 |
3 files changed, 36 insertions, 1 deletions
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 40cc44d20eb..3796614bcf5 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -1352,7 +1352,9 @@ impl Context { fn ignore_private_item(&self, it: &clean::Item) -> bool { match it.inner { clean::ModuleItem(ref m) => { - (m.items.len() == 0 && it.doc_value().is_none()) || + (m.items.len() == 0 && + it.doc_value().is_none() && + it.visibility != Some(ast::Public)) || (self.passes.contains("strip-private") && it.visibility != Some(ast::Public)) } clean::PrimitiveItem(..) => it.visibility != Some(ast::Public), diff --git a/src/test/rustdoc/issue-16265-1.rs b/src/test/rustdoc/issue-16265-1.rs new file mode 100644 index 00000000000..c0b99a627ea --- /dev/null +++ b/src/test/rustdoc/issue-16265-1.rs @@ -0,0 +1,18 @@ +// Copyright 2015 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; + +// @has issue_16265_1/traits/index.html '[src]' +pub mod traits { + impl PartialEq for super::Foo { + fn eq(&self, _: &super::Foo) -> bool { true } + } +} diff --git a/src/test/rustdoc/issue-16265-2.rs b/src/test/rustdoc/issue-16265-2.rs new file mode 100644 index 00000000000..22a8df407e0 --- /dev/null +++ b/src/test/rustdoc/issue-16265-2.rs @@ -0,0 +1,15 @@ +// Copyright 2015 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. + + +// @has issue_16265_2/index.html '[src]' + +trait Y {} +impl Y for Option<u32>{} |
