Issue #14625: fixed inspections violations MismatchedJavadocCode

[MANISH-K-07]

Part of #14625

Deals with MismatchedJavadocCode inspection.

<problems is_local_tool="true">
<problem>
<file>file://$PROJECT_DIR$/src/main/java/com/puppycrawl/tools/checkstyle/ant/CheckstyleAntTask.java</file>
<line>450</line>
<module>project</module>
<package>com.puppycrawl.tools.checkstyle.ant</package>
<entry_point TYPE="method" FQNAME="com.puppycrawl.tools.checkstyle.ant.CheckstyleAntTask com.puppycrawl.tools.checkstyle.api.AuditListener[] getListeners()"/>
<problem_class id="MismatchedJavadocCode" severity="WARNING" attribute_key="WARNING_ATTRIBUTES">Mismatch between Javadoc and code</problem_class>
<description>Method is specified to return list but the return type is array</description>
<highlighted_element>list</highlighted_element>
<language>JAVA</language>
<offset>19</offset>
<length>4</length>
</problem>

<problem>
<file>file://$PROJECT_DIR$/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java</file>
<line>637</line>
<module>project</module>
<package>com.puppycrawl.tools.checkstyle.checks.coding</package>
<entry_point TYPE="method" FQNAME="com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.FieldFrame com.puppycrawl.tools.checkstyle.api.DetailAST findField(java.lang.String name)"/>
<problem_class id="MismatchedJavadocCode" severity="WARNING" attribute_key="WARNING_ATTRIBUTES">Mismatch between Javadoc and code</problem_class>
<description>Method is specified to return 'true' but its return type is not boolean</description>
<highlighted_element>true</highlighted_element>
<language>JAVA</language>
<offset>19</offset>
<length>4</length>
</problem>

<problem>
<file>file://$PROJECT_DIR$/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/UnusedLocalVariableCheck.java</file>
<line>520</line>
<module>project</module>
<package>com.puppycrawl.tools.checkstyle.checks.coding</package>
<entry_point TYPE="method" FQNAME="com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck java.util.List<com.puppycrawl.tools.checkstyle.checks.coding.UnusedLocalVariableCheck.TypeDeclDesc> typeDeclWithSameName(java.lang.String superClassName)"/>
<problem_class id="MismatchedJavadocCode" severity="WARNING" attribute_key="WARNING_ATTRIBUTES">Mismatch between Javadoc and code</problem_class>
<description>Method is specified to return 'true' but its return type is not boolean</description>
<highlighted_element>true</highlighted_element>
<language>JAVA</language>
<offset>15</offset>
<length>4</length>
</problem>
</problems>

[MANISH-K-07]

No more violation of MismatchedJavadocCode inspection....

https://app.circleci.com/pipelines/github/checkstyle/checkstyle/25240/workflows/1c68133e-8124-46bf-8dab-93fd474e3ab4/jobs/577665?invite=true#step-104-109_91

[MANISH-K-07]

@romani , ping please.

[MANISH-K-07]

@nrmancuso , ping please.

[nrmancuso]

What a great inspection! Thanks for the update.

[MANISH-K-07]

@nrmancuso , could you please tell me what version of IntelliJ do you use?

I have been speaking in the forum and they are saying that the scopes should not be a problem in 2024 tags. I have tried to run the latest version yesterday but it seems to crash on my pc.

If you or @romani are using the latest version, could you please confirm if the scopes are working fine?

[nrmancuso]

If you or @romani are using the latest version, could you please confirm if the scopes are working fine?

Is this the version that our last image used?

[MANISH-K-07]

@nrmancuso , our current image is 2022.3.3 after migration.

We have tried 2023.3.4 but scopes were problematic so we reported to them.

The latest is 2024.1 released on April 4th and we did not test this until now.
https://youtrack.jetbrains.com/articles/IDEA-A-2100661899/IntelliJ-IDEA-2024.1-241.14494.240-build-Release-Notes

[nrmancuso]

Different machines can have different behavior sadly, the only way to know if 2024.1 solves the issue for us is to build the image and try it out.

[MANISH-K-07]

Sure, will try in that case :)

[romani]

@MANISH-K-07 ,

it looks like it is working !!!!
Build #IU-241.14494.240, built on March 27, 2024

[MANISH-K-07]

it looks like it is working !!!!

@romani , that's great news, let's try this version. I will send PR as soon as I can
Looks like we have 250+ inspection problems that we have to deal with :)

Build #IU-241.14494.240 they have some good amount of updates as part of first 24 tag