Update rustdoc tests and add test for #[doc(hidden)] re-exports.

Author: GuillaumeGomez

tests/rustdoc/doc-hidden-reexports.rs

@@ -0,0 +1,114 @@
+// Test to enforce rules over re-exports inlining from
+// <https://github.com/rust-lang/rust/issues/109449>.
+
+#![crate_name = "foo"]
+
+mod private_module {
+    #[doc(hidden)]
+    pub struct Public;
+    #[doc(hidden)]
+    pub type Bar = ();
+}
+
+#[doc(hidden)]
+mod module {
+    pub struct Public2;
+    pub type Bar2 = ();
+}
+
+#[doc(hidden)]
+pub type Bar3 = ();
+#[doc(hidden)]
+pub struct FooFoo;
+
+// Checking that re-exporting a `#[doc(hidden)]` item will inline it.
+pub mod single_reexport {
+    // @has 'foo/single_reexport/index.html'
+
+    // First we check that we have all 6 items: 3 structs and 3 type aliases.
+    // @count - '//a[@class="struct"]' 3
+    // @count - '//a[@class="type"]' 3
+
+    // Then we check that we have the correct link for each re-export.
+
+    // @has - '//*[@href="struct.Foo.html"]' 'Foo'
+    pub use crate::private_module::Public as Foo;
+    // @has - '//*[@href="type.Foo2.html"]' 'Foo2'
+    pub use crate::private_module::Bar as Foo2;
+    // @has - '//*[@href="type.Yo.html"]' 'Yo'
+    pub use crate::Bar3 as Yo;
+    // @has - '//*[@href="struct.Yo2.html"]' 'Yo2'
+    pub use crate::FooFoo as Yo2;
+    // @has - '//*[@href="struct.Foo3.html"]' 'Foo3'
+    pub use crate::module::Public2 as Foo3;
+    // @has - '//*[@href="type.Foo4.html"]' 'Foo4'
+    pub use crate::module::Bar2 as Foo4;
+
+    // Checking that each file is also created as expected.
+    // @has 'foo/single_reexport/struct.Foo.html'
+    // @has 'foo/single_reexport/type.Foo2.html'
+    // @has 'foo/single_reexport/type.Yo.html'
+    // @has 'foo/single_reexport/struct.Yo2.html'
+    // @has 'foo/single_reexport/struct.Foo3.html'
+    // @has 'foo/single_reexport/type.Foo4.html'
+}
+
+// Checking that re-exporting a `#[doc(hidden)]` item with `#[doc(no_inline)]` will not inline
+// it but will still display a re-export in the documentation.
+pub mod single_reexport_no_inline {
+    // First we ensure that we only have re-exports and no inlined items.
+    // @has 'foo/single_reexport_no_inline/index.html'
+    // @count - '//*[@id="main-content"]/*[@class="small-section-header"]' 1
+    // @has - '//*[@id="main-content"]/*[@class="small-section-header"]' 'Re-exports'
+
+    // Now we check that we don't have links to the items, just `pub use`.
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::private_module::Public as XFoo;'
+    // @!has - '//*[@id="main-content"]//a' 'XFoo'
+    #[doc(no_inline)]
+    pub use crate::private_module::Public as XFoo;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::private_module::Bar as Foo2;'
+    // @!has - '//*[@id="main-content"]//a' 'Foo2'
+    #[doc(no_inline)]
+    pub use crate::private_module::Bar as Foo2;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::Bar3 as Yo;'
+    // @!has - '//*[@id="main-content"]//a' 'Yo'
+    #[doc(no_inline)]
+    pub use crate::Bar3 as Yo;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::FooFoo as Yo2;'
+    // @!has - '//*[@id="main-content"]//a' 'Yo2'
+    #[doc(no_inline)]
+    pub use crate::FooFoo as Yo2;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::module::Public2 as Foo3;'
+    // @!has - '//*[@id="main-content"]//a' 'Foo3'
+    #[doc(no_inline)]
+    pub use crate::module::Public2 as Foo3;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::module::Bar2 as Foo4;'
+    // @!has - '//*[@id="main-content"]//a' 'Foo4'
+    #[doc(no_inline)]
+    pub use crate::module::Bar2 as Foo4;
+}
+
+// Checking that glob re-exports don't inline `#[doc(hidden)]` items.
+pub mod glob_reexport {
+    // With glob re-exports, we don't inline `#[doc(hidden)]` items so only `module` items
+    // should be inlined.
+    // @has 'foo/glob_reexport/index.html'
+    // @count - '//*[@id="main-content"]/*[@class="small-section-header"]' 3
+    // @has - '//*[@id="main-content"]/*[@class="small-section-header"]' 'Re-exports'
+    // @has - '//*[@id="main-content"]/*[@class="small-section-header"]' 'Structs'
+    // @has - '//*[@id="main-content"]/*[@class="small-section-header"]' 'Type Definitions'
+
+    // Now we check we have 2 re-exports and 2 inlined items.
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::private_module::*;'
+    pub use crate::private_module::*;
+    // @has - '//*[@id="main-content"]//*' 'pub use crate::*;'
+    pub use crate::*;
+    // This one should be inlined.
+    // @!has - '//*[@id="main-content"]//*' 'pub use crate::module::*;'
+    // @has - '//*[@id="main-content"]//a[@href="struct.Public2.html"]' 'Public2'
+    // @has - '//*[@id="main-content"]//a[@href="type.Bar2.html"]' 'Bar2'
+    // And we check that the two files were created too.
+    // @has 'foo/glob_reexport/struct.Public2.html'
+    // @has 'foo/glob_reexport/type.Bar2.html'
+    pub use crate::module::*;
+}

tests/rustdoc/reexport-attr-merge.rs

@@ -4,6 +4,8 @@
 
 #![crate_name = "foo"]
 #![feature(doc_cfg)]
+#![feature(no_core)]
+#![no_core]
 
 // @has 'foo/index.html'
 
@@ -20,14 +22,13 @@ pub use Foo1 as Foo2;
 // are inlined.
 // @count - '//a[@class="struct"]' 2
 // Then we check that both `cfg` are displayed.
-// @has - '//*[@class="stab portability"]' 'foo'
-// @has - '//*[@class="stab portability"]' 'bar'
+// @matches - '//*[@class="stab portability"]' '^foo$'
 // And finally we check that the only element displayed is `Bar`.
-// @has - '//a[@class="struct"]' 'Bar'
+// @has - '//a[@href="struct.Bar.html"]' 'Bar'
 #[doc(inline)]
-pub use Foo2 as Bar;
+pub use Foo as Bar;
 
-// This one should appear but `Bar2` won't be linked because there is no
-// `#[doc(inline)]`.
-// @has - '//*[@id="reexport.Bar2"]' 'pub use Foo2 as Bar2;'
+// Re-exported `#[doc(hidden)]` items are inlined as well.
+// @has - '//a[@href="struct.Bar2.html"]' 'Bar2'
+// @matches - '//*[@class="stab portability"]' '^bar and foo$'
 pub use Foo2 as Bar2;