From 9f4c117fb27f4b5a6797570079f16668d8d59f97 Mon Sep 17 00:00:00 2001 From: Bartek Pacia Date: Mon, 13 Oct 2025 11:09:58 +0200 Subject: [PATCH] [java-inspections] IJ-CR-177985 improve inspection descriptions Related: IDEA-372834 GitOrigin-RevId: 6cceb2c89e45572f6244768031ef29fe455eb437 --- .../messages/InspectionGadgetsBundle.properties | 1 + ...nalOnLocalVariableOrParameterInspection.java | 2 ++ .../inspectionDescriptions/LocalCanBeFinal.html | 4 ++-- ...ecessaryFinalOnLocalVariableOrParameter.html | 17 +---------------- 4 files changed, 6 insertions(+), 18 deletions(-) diff --git a/java/java-analysis-impl/resources/messages/InspectionGadgetsBundle.properties b/java/java-analysis-impl/resources/messages/InspectionGadgetsBundle.properties index 3f094eea31c9..d41fe04481ff 100644 --- a/java/java-analysis-impl/resources/messages/InspectionGadgetsBundle.properties +++ b/java/java-analysis-impl/resources/messages/InspectionGadgetsBundle.properties @@ -1868,6 +1868,7 @@ unnecessary.final.report.method.parameters.option=Report method parameters unnecessary.final.report.foreach.parameters.option=Report foreach parameter unnecessary.final.report.catch.parameters.option=Report catch parameters unnecessary.final.on.parameter.only.interface.option=Only warn on abstract or interface methods +unnecessary.final.on.parameter.only.interface.option.description=final parameters of abstract or interface methods may be considered extra unnecessary as they don't affect the implementation of these methods. choose.exception.class=Choose Exception Class choose.exception.label=Prohibited exceptions: class.independent.of.module.display.name=Class independent of its module diff --git a/java/java-analysis-impl/src/com/siyeh/ig/style/UnnecessaryFinalOnLocalVariableOrParameterInspection.java b/java/java-analysis-impl/src/com/siyeh/ig/style/UnnecessaryFinalOnLocalVariableOrParameterInspection.java index d0380d88c929..bcd156878ada 100644 --- a/java/java-analysis-impl/src/com/siyeh/ig/style/UnnecessaryFinalOnLocalVariableOrParameterInspection.java +++ b/java/java-analysis-impl/src/com/siyeh/ig/style/UnnecessaryFinalOnLocalVariableOrParameterInspection.java @@ -18,6 +18,7 @@ package com.siyeh.ig.style; import com.intellij.codeInspection.CleanupLocalInspectionTool; import com.intellij.codeInspection.LocalQuickFix; import com.intellij.codeInspection.options.OptPane; +import com.intellij.openapi.util.text.HtmlChunk; import com.intellij.pom.java.JavaFeature; import com.intellij.psi.*; import com.intellij.psi.util.PsiTreeUtil; @@ -71,6 +72,7 @@ public final class UnnecessaryFinalOnLocalVariableOrParameterInspection extends checkbox("reportPatternVariables", InspectionGadgetsBundle.message("unnecessary.final.report.pattern.variables.option")), checkbox("reportParameters", InspectionGadgetsBundle.message("unnecessary.final.report.method.parameters.option"), checkbox("onlyWarnOnAbstractMethods",InspectionGadgetsBundle.message("unnecessary.final.on.parameter.only.interface.option")) + .description(HtmlChunk.raw(InspectionGadgetsBundle.message("unnecessary.final.on.parameter.only.interface.option.description"))) ), checkbox("reportCatchParameters", InspectionGadgetsBundle.message("unnecessary.final.report.catch.parameters.option")), checkbox("reportForeachParameters", InspectionGadgetsBundle.message("unnecessary.final.report.foreach.parameters.option")) diff --git a/java/java-impl/resources/inspectionDescriptions/LocalCanBeFinal.html b/java/java-impl/resources/inspectionDescriptions/LocalCanBeFinal.html index f96edc42fe74..84f5629cef19 100644 --- a/java/java-impl/resources/inspectionDescriptions/LocalCanBeFinal.html +++ b/java/java-impl/resources/inspectionDescriptions/LocalCanBeFinal.html @@ -1,6 +1,6 @@ -Reports parameters or local variables that may have the final modifier added to their declaration. +Reports local variables or parameters that may have the final modifier added to their declaration.

Example:


   ArrayList<Integer> list = new ArrayList();
@@ -15,7 +15,7 @@ Reports parameters or local variables that may have the final modif

- Use the inspection's options to define whether parameters or local variables should be reported. + Use the inspection's options to define what kinds of parameters or local variables should be reported.

diff --git a/java/java-impl/resources/inspectionDescriptions/UnnecessaryFinalOnLocalVariableOrParameter.html b/java/java-impl/resources/inspectionDescriptions/UnnecessaryFinalOnLocalVariableOrParameter.html index fc06a01e3a17..203dd93b767c 100644 --- a/java/java-impl/resources/inspectionDescriptions/UnnecessaryFinalOnLocalVariableOrParameter.html +++ b/java/java-impl/resources/inspectionDescriptions/UnnecessaryFinalOnLocalVariableOrParameter.html @@ -24,22 +24,7 @@ Reports local variables or parameters unnecessarily declared final.

- Use the inspection options to toggle the reporting for: + Use the inspection's options to define what kinds of parameters or local variables should be reported.

- -

- Also, you can configure the inspection to only report final parameters of abstract or interface - methods, which may be considered extra unnecessary as such markings don't - affect the implementation of these methods. -

- \ No newline at end of file