]> git.lizzy.rs Git - rust.git/commitdiff
rustdoc: Only hide possibly private modules
authorAlex Crichton <alex@alexcrichton.com>
Mon, 6 Apr 2015 23:43:55 +0000 (16:43 -0700)
committerAlex Crichton <alex@alexcrichton.com>
Wed, 8 Apr 2015 00:54:34 +0000 (17:54 -0700)
If an empty public module has no documentation, it shouldn't emit a page that's
just a redirect loop to itself!

Closes #16265

src/librustdoc/html/render.rs
src/test/rustdoc/issue-16265-1.rs [new file with mode: 0644]
src/test/rustdoc/issue-16265-2.rs [new file with mode: 0644]

index 40cc44d20eb1a3f9a8e39bcd2d31957ea53cc555..3796614bcf5a9b6885fb240d2ace989c8fe9bd28 100644 (file)
@@ -1352,7 +1352,9 @@ fn build_sidebar_items(&self, m: &clean::Module) -> HashMap<String, Vec<NameDoc>
     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 (file)
index 0000000..c0b99a6
--- /dev/null
@@ -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 (file)
index 0000000..22a8df4
--- /dev/null
@@ -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>{}