about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume.gomez@huawei.com>2023-01-17 20:41:16 +0100
committerGuillaume Gomez <guillaume.gomez@huawei.com>2023-01-27 20:33:42 +0100
commit4b3eef873407ab49918f941810e69c47c79a2b3c (patch)
tree0d3992ff197d69e2c7ce77a259fe4685e8d352d7
parentc918efa6642c4ca6611068d09e7341731fd00a80 (diff)
downloadrust-4b3eef873407ab49918f941810e69c47c79a2b3c.tar.gz
rust-4b3eef873407ab49918f941810e69c47c79a2b3c.zip
Add rustdoc test to ensure that items into a `doc(hidden)` block are handled as expected
-rw-r--r--tests/rustdoc/hidden-private.rs50
1 files changed, 50 insertions, 0 deletions
diff --git a/tests/rustdoc/hidden-private.rs b/tests/rustdoc/hidden-private.rs
new file mode 100644
index 00000000000..834ba5231a1
--- /dev/null
+++ b/tests/rustdoc/hidden-private.rs
@@ -0,0 +1,50 @@
+// This is a regression test for <https://github.com/rust-lang/rust/issues/106373>.
+// It ensures that the items in the `doc(hidden)` const block don't show up in the
+// generated docs.
+
+// compile-flags: --document-private-items
+
+#![crate_name = "foo"]
+
+// @has 'foo/index.html'
+// @count - '//*[@class="item-table"]//a[@class="struct"]' 2
+// @count - '//*[@class="item-table"]//a[@class="trait"]' 1
+// @count - '//*[@class="item-table"]//a[@class="macro"]' 0
+#[doc(hidden)]
+const _: () = {
+    macro_rules! stry {
+        () => {};
+    }
+
+    struct ShouldBeHidden;
+
+    // @has 'foo/struct.Foo.html'
+    // @!has - '//*[@class="code-header"]' 'impl Bar for Foo'
+    #[doc(hidden)]
+    impl Bar for Foo {
+        fn bar(&self) {
+            struct SHouldAlsoBeHidden;
+        }
+    }
+
+    // @has 'foo/struct.Private.html'
+    // @has - '//*[@id="impl-Bar-for-Private"]/*[@class="code-header"]' 'impl Bar for Private'
+    // @has - '//*[@id="method.bar"]/*[@class="code-header"]' 'fn bar(&self)'
+    impl Bar for Private {
+        fn bar(&self) {}
+    }
+
+    // @has - '//*[@id="impl-Private"]/*[@class="code-header"]' 'impl Private'
+    // @has - '//*[@id="method.tralala"]/*[@class="code-header"]' 'fn tralala()'
+    impl Private {
+        fn tralala() {}
+    }
+};
+
+
+struct Private;
+pub struct Foo;
+
+pub trait Bar {
+    fn bar(&self);
+}