diff options
| author | bors <bors@rust-lang.org> | 2016-06-14 05:04:38 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-14 05:04:38 -0700 |
| commit | 2940eb54bd805dfe45fbf3313688246427eccbc8 (patch) | |
| tree | c667bf06cf3f809439f94f8dc0f0d73b793306c3 /src/test/rustdoc | |
| parent | 1af8f3e362fd1c931503703079467df027b57cdb (diff) | |
| parent | a7c467418fe552762dfff1be5405c35ef7407f38 (diff) | |
| download | rust-2940eb54bd805dfe45fbf3313688246427eccbc8.tar.gz rust-2940eb54bd805dfe45fbf3313688246427eccbc8.zip | |
Auto merge of #34232 - ollie27:rustdoc_inline, r=alexcrichton
rustdoc: Don't inline #[doc(hidden)] pub use Currently if a `#[doc(hidden)] pub use` item is inlined the `hidden` attribute is ignored so the item can appear in the docs. By never inlining such imports, they can be stripped. An example in `std` is [`__OsLocalKeyInner`](https://doc.rust-lang.org/nightly/std/thread/struct.__OsLocalKeyInner.html) which clearly should not be documented.
Diffstat (limited to 'src/test/rustdoc')
| -rw-r--r-- | src/test/rustdoc/inline_cross/hidden-use.rs | 22 | ||||
| -rw-r--r-- | src/test/rustdoc/inline_local/hidden-use.rs | 20 |
2 files changed, 42 insertions, 0 deletions
diff --git a/src/test/rustdoc/inline_cross/hidden-use.rs b/src/test/rustdoc/inline_cross/hidden-use.rs new file mode 100644 index 00000000000..dd668c20362 --- /dev/null +++ b/src/test/rustdoc/inline_cross/hidden-use.rs @@ -0,0 +1,22 @@ +// 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:rustdoc-hidden.rs +// build-aux-docs +// ignore-cross-compile + +extern crate rustdoc_hidden; + +// @has hidden_use/index.html +// @!has - 'rustdoc_hidden' +// @!has - 'Bar' +// @!has hidden_use/struct.Bar.html +#[doc(hidden)] +pub use rustdoc_hidden::Bar; diff --git a/src/test/rustdoc/inline_local/hidden-use.rs b/src/test/rustdoc/inline_local/hidden-use.rs new file mode 100644 index 00000000000..1b1dafcf58b --- /dev/null +++ b/src/test/rustdoc/inline_local/hidden-use.rs @@ -0,0 +1,20 @@ +// 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. + +mod private { + pub struct Foo {} +} + +// @has hidden_use/index.html +// @!has - 'private' +// @!has - 'Foo' +// @!has hidden_use/struct.Foo.html +#[doc(hidden)] +pub use private::Foo; |
