Skip to content

Commit

Permalink
don't lint nested items that don't have generated documentation in `m…
Browse files Browse the repository at this point in the history
…issing_docs_in_private_items`
  • Loading branch information
y21 committed Oct 20, 2024
1 parent 2f71ce6 commit b3bf128
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
16 changes: 16 additions & 0 deletions clippy_lints/src/missing_doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ use clippy_utils::is_from_proc_macro;
use clippy_utils::source::SpanRangeExt;
use rustc_ast::ast::{self, MetaItem, MetaItemKind};
use rustc_hir as hir;
use rustc_hir::def::DefKind;
use rustc_hir::def_id::LocalDefId;
use rustc_lint::{LateContext, LateLintPass, LintContext};
use rustc_middle::ty::Visibility;
Expand Down Expand Up @@ -111,6 +112,21 @@ impl MissingDoc {
return;
}

if let Some(parent_def_id) = cx.tcx.opt_parent(def_id.to_def_id())
&& let DefKind::AnonConst
| DefKind::AssocConst
| DefKind::AssocFn
| DefKind::Closure
| DefKind::Const
| DefKind::Fn
| DefKind::InlineConst
| DefKind::Static { .. }
| DefKind::SyntheticCoroutineBody = cx.tcx.def_kind(parent_def_id)
{
// Nested item has no generated documentation, so it doesn't need to be documented.
return;
}

let has_doc = attrs
.iter()
.any(|a| a.doc_str().is_some() || Self::has_include(a.meta()))
Expand Down
5 changes: 5 additions & 0 deletions tests/ui/missing_doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ with_span!(span pub const FOO2_PM: u32 = 0;);
// Don't lint unnamed constants
const _: () = ();

fn issue13298() {
// Rustdoc doesn't generate documentation for items within other items like fns or consts
const MSG: &str = "Hello, world!";
}

// issue #12197
// Undocumented field originated inside of spanned proc-macro attribute
/// Some dox for struct.
Expand Down
11 changes: 10 additions & 1 deletion tests/ui/missing_doc.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,14 @@ error: missing documentation for a function
LL | fn also_undocumented2() {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to 13 previous errors
error: missing documentation for a function
--> tests/ui/missing_doc.rs:122:1
|
LL | / fn issue13298() {
LL | | // Rustdoc doesn't generate documentation for items within other items like fns or consts
LL | | const MSG: &str = "Hello, world!";
LL | | }
| |_^

error: aborting due to 14 previous errors

0 comments on commit b3bf128

Please sign in to comment.