Skip to content

Commit

Permalink
Check implementing type for #[doc(hidden)]
Browse files Browse the repository at this point in the history
Closes #85526.
  • Loading branch information
pierwill committed Oct 17, 2021
1 parent 6f53ddf commit d39a1be
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
18 changes: 18 additions & 0 deletions compiler/rustc_lint/src/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,24 @@ impl<'tcx> LateLintPass<'tcx> for MissingDoc {
return;
}

// If the method is an impl for an item with docs_hidden, don't doc.
if method_context(cx, impl_item.hir_id()) == MethodLateContext::PlainImpl {
let parent = cx.tcx.hir().get_parent_did(impl_item.hir_id());
let impl_ty = cx.tcx.type_of(parent);
let outerdef = match impl_ty.kind() {
ty::Adt(def, _) => Some(def.did),
ty::Foreign(def_id) => Some(*def_id),
_ => None,
};
let is_hidden = match outerdef {
Some(id) => cx.tcx.is_doc_hidden(id),
None => false,
};
if is_hidden {
return;
}
}

let (article, desc) = cx.tcx.article_and_description(impl_item.def_id.to_def_id());
self.check_missing_docs_attrs(cx, impl_item.def_id, impl_item.span, article, desc);
}
Expand Down
15 changes: 15 additions & 0 deletions src/test/ui/hidden-doc-associated-item.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// check-pass
// See issue #85526.
// This test should produce no warnings.

#![deny(missing_docs)]
//! Crate docs
#[doc(hidden)]
pub struct Foo;

impl Foo {
pub fn bar() {}
}

fn main() {}

0 comments on commit d39a1be

Please sign in to comment.