MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-04-19 04:51:24 +07:00
Code Issues Packages Projects Releases Wiki Activity

Don't warn about missing tag description on void methods

Browse Source 
GitOrigin-RevId: 7125c41e5adfb4a45f96b6f5c9b6db12a9a0da6d
This commit is contained in:
Andrey.Cherkasov
2020-11-20 21:10:26 +03:00
committed by intellij-monorepo-bot
parent ea5b5de628
commit 1a75f19cff
4 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
java/java-impl/src/com/intellij/codeInspection/javaDoc/JavaDocLocalInspection.java
View File

@@ -326,7 +326,7 @@ public class JavaDocLocalInspection extends LocalInspectionTool {
}
if (!myIgnoreEmptyDescriptions) {
JavadocHighlightUtil.checkEmptyMethodTagsDescription(tags, holder);
JavadocHighlightUtil.checkEmptyMethodTagsDescription(tags, method, holder);
}
checkBasics(docComment, tags, method, false, METHOD_OPTIONS, holder);

6
java/java-impl/src/com/intellij/codeInspection/javaDoc/JavadocHighlightUtil.java
View File

@@ -438,14 +438,16 @@ public final class JavadocHighlightUtil {
}
}
static void checkEmptyMethodTagsDescription(PsiDocTag @NotNull [] tags, @NotNull ProblemHolder holder) {
static void checkEmptyMethodTagsDescription(PsiDocTag @NotNull [] tags,
@NotNull PsiMethod psiMethod,
@NotNull ProblemHolder holder) {
for (PsiDocTag tag : tags) {
if (ContainerUtil
.exists(tag.getChildren(), e -> e instanceof PsiInlineDocTag && ((PsiInlineDocTag)e).getName().equals("inheritDoc"))) {
continue;
}
if ("return".equals(tag.getName())) {
if (emptyTag(tag)) {
if (!PsiType.VOID.equals(psiMethod.getReturnType()) && emptyTag(tag)) {
String tagText = "<code>@return</code>";
LocalQuickFix fix = holder.removeTagWithoutDescriptionFix("return");
holder.problem(tag.getNameElement(), JavaBundle.message("inspection.javadoc.method.problem.missing.tag.description", tagText), fix);

6
java/java-tests/testData/codeInsight/daemonCodeAnalyzer/javaDoc/Return1.java Normal file
View File

@@ -0,0 +1,6 @@
class Test {
/**
* <warning descr="Tag 'return' is not allowed here">@return</warning>
*/
public void foo() {}
}

1
java/java-tests/testSrc/com/intellij/java/codeInsight/daemon/JavadocHighlightingTest.java
View File

@@ -74,6 +74,7 @@ public class JavadocHighlightingTest extends LightDaemonAnalyzerTestCase {
public void testSeeConstants() { doTest(); }
public void testSeeNonRefs() { doTest(); }
public void testReturn0() { doTest(); }
public void testReturn1() { doTest(); }
public void testException0() { doTest(); }
public void testException1() { doTest(); }
public void testException2() { doTest(); }