Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rustdoc: Do not list impl when trait has doc(hidden) #86513

Merged
merged 3 commits into from
Jun 25, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/librustdoc/clean/inline.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! Support for inlining external documentation into the current AST.

use std::collections::VecDeque;
use std::iter::once;
use std::sync::Arc;

Expand All @@ -15,7 +16,9 @@ use rustc_span::hygiene::MacroKind;
use rustc_span::symbol::{kw, sym, Symbol};
use rustc_span::Span;

use crate::clean::{self, Attributes, AttributesExt, FakeDefId, GetDefId, ToSource};
use crate::clean::{
self, Attributes, AttributesExt, FakeDefId, GetDefId, NestedAttributesExt, ToSource, Type,
};
use crate::core::DocContext;
use crate::formats::item_type::ItemType;

Expand Down Expand Up @@ -420,6 +423,20 @@ crate fn build_impl(
if trait_.def_id() == tcx.lang_items().deref_trait() {
super::build_deref_target_impls(cx, &trait_items, ret);
}

// Return if the trait itself or any types of the generic parameters are doc(hidden).
let mut deque: VecDeque<&Type> = trait_.iter().collect();
while let Some(ty) = deque.pop_back() {
if let Some(did) = ty.def_id() {
if cx.tcx.get_attrs(did).lists(sym::doc).has_word(sym::hidden) {
return;
}
}
if let Some(generics) = ty.generics() {
deque.extend(generics);
}
}
fee1-dead marked this conversation as resolved.
Show resolved Hide resolved

if let Some(trait_did) = trait_.def_id() {
record_extern_trait(cx, trait_did);
}
Expand Down
2 changes: 2 additions & 0 deletions src/test/rustdoc/auxiliary/cross-crate-hidden.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#[doc(hidden)]
pub enum HiddenType {}
23 changes: 23 additions & 0 deletions src/test/rustdoc/cross-crate-hidden.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Issue #86448: test for cross-crate `doc(hidden)`
#![crate_name = "foo"]

// aux-build:cross-crate-hidden.rs
extern crate cross_crate_hidden;

pub use ::cross_crate_hidden::HiddenType; // OK, not re-exported

pub enum MyLibType {}

// @!has foo/enum.MyLibType.html '//*[@id="impl-From%3CHiddenType%3E"]' 'impl From<HiddenType> for MyLibType'
impl From<HiddenType> for MyLibType {
fn from(it: HiddenType) -> MyLibType {
match it {}
}
}

// @!has foo/enum.MyLibType.html '//*[@id="impl-From%3COption%3COption%3COption%3COption%3CHiddenType%3E%3E%3E%3E%3E"]' 'impl From<Option<Option<Option<Option<HiddenType>>>>> for MyLibType'
impl From<Option<Option<Option<Option<HiddenType>>>>> for MyLibType {
fn from(it: Option<Option<Option<Option<HiddenType>>>>) -> MyLibType {
todo!()
}
}