MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-13 21:55:01 +07:00
Code Issues Packages Projects Releases Wiki Activity

Java: report missing @param on records (IDEA-310177)

Browse Source 
GitOrigin-RevId: c79523e30672943fb0901be3460977d503847bf3
This commit is contained in:
Bas Leijdekkers
2025-02-20 18:48:19 +00:00
committed by intellij-monorepo-bot
parent be1496bc7a
commit b57e6e098b
3 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
java/java-impl/src/com/intellij/codeInspection/javaDoc/MissingJavadocInspection.java
+28 -4
View File
@@ -40,7 +40,7 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
public Options PACKAGE_SETTINGS = new Options();
public Options MODULE_SETTINGS = new Options();
public Options TOP_LEVEL_CLASS_SETTINGS = new Options("@param");
public Options INNER_CLASS_SETTINGS = new Options();
public Options INNER_CLASS_SETTINGS = new Options("@param");
public Options METHOD_SETTINGS = new Options("@return@param@throws or @exception");
public Options FIELD_SETTINGS = new Options();
@@ -73,7 +73,7 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
List.of(PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE), List.of())
.prefix("FIELD_SETTINGS"),
INNER_CLASS_SETTINGS.getComponent(JavaBundle.message("inspection.javadoc.option.tab.title.inner.class"),
List.of(PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE), List.of())
List.of(PUBLIC, PROTECTED, PACKAGE_LOCAL, PRIVATE), List.of("@param"))
.prefix("INNER_CLASS_SETTINGS")
)
);
@@ -206,10 +206,12 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
if (docComment != null) {
PsiDocTag[] tags = docComment.getTags();
checkRequiredTags(tags, options, docComment.getFirstChild(), holder);
PsiElement toHighlight = docComment.getFirstChild();
checkRequiredTags(tags, options, toHighlight, holder);
if (options.isTagRequired("param")) {
checkMissingTypeParamTags(aClass, tags, docComment.getFirstChild(), holder);
checkMissingTypeParamTags(aClass, tags, toHighlight, holder);
checkMissingParamTags(aClass, tags, toHighlight, holder);
}
}
else {
@@ -395,6 +397,22 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
}
}
private static void checkMissingParamTags(@NotNull PsiClass aClass,
PsiDocTag @NotNull [] tags,
@NotNull PsiElement toHighlight,
@NotNull ProblemsHolder holder) {
if (!aClass.isRecord()) return;
List<PsiNamedElement> absentParameters = null;
for (PsiRecordComponent param : aClass.getRecordComponents()) {
if (!hasTagForParameter(tags, param)) {
(absentParameters = list(absentParameters)).add(param);
}
}
reportMissingParamTags(absentParameters, toHighlight, holder);
}
private static void checkMissingParamTags(@NotNull PsiMethod psiMethod,
PsiDocTag @NotNull [] tags,
@NotNull PsiElement toHighlight,
@@ -407,6 +425,12 @@ public final class MissingJavadocInspection extends LocalInspectionTool {
}
}
reportMissingParamTags(absentParameters, toHighlight, holder);
}
private static void reportMissingParamTags(List<PsiNamedElement> absentParameters,
@NotNull PsiElement toHighlight,
@NotNull ProblemsHolder holder) {
if (absentParameters != null) {
for (PsiNamedElement parameter : absentParameters) {
String name = parameter.getName();
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/missingJavadoc/InnerClassEnabled.java
+5
View File
@@ -26,4 +26,9 @@ public class InnerClassEnabled {
private static class Inner2 {
}
<warning descr="Required tag '@param' is missing for parameter 'x'"><warning descr="Required tag '@param' is missing for parameter 'y'">/**</warning></warning>
* You have a point.
*/
public record Point(int x, int y) {}
}
java/java-tests/testSrc/com/intellij/java/codeInsight/daemon/JavadocSettingsMergerTest.kt
+2 -2
View File
@@ -1,4 +1,4 @@
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
// Copyright 2000-2025 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.java.codeInsight.daemon
import com.intellij.codeInspection.InspectionProfileEntry
@@ -232,7 +232,7 @@ class JavadocSettingsMergerTest: LightJavaCodeInsightFixtureTestCase5() {
<option name="INNER_CLASS_OPTIONS">
<value>
<option name="ACCESS_JAVADOC_REQUIRED_FOR" value="public" />
<option name="REQUIRED_TAGS" value="" />
<option name="REQUIRED_TAGS" value="@param" />
</value>
</option>
<option name="METHOD_OPTIONS">