Skip to content

False positive from JavadocType: Unused @param tag #17332

@turbanoff

Description

@turbanoff

I have read check documentation: https://checkstyle.org/checks/javadoc/javadoctype.html
I have downloaded the latest checkstyle from: https://checkstyle.org/cmdline.html#Download_and_Run
I have executed the cli and showed it below, as cli describes the problem better than 1,000 words

$ javac WithNative.java

$ cat config.xml
<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="TreeWalker">
        <module name="JavadocType">
            <property name="authorFormat" value="\S"/>
            <property name="allowMissingParamTags" value="true"/>
            <property name="allowUnknownTags" value="true"/>
        </module>
    </module>
</module>

$ cat WithNative.java
import java.util.Collection;

public class WithNative {

    /**
     * Creates Plugin
     *
     * @param chartComponent chart component
     * @return plugin
     */
    private native String createPlugin(Long chartComponent) /*-{
        return pluginModel;
    }-*/;

    private interface PluginModel {
    }
}

$ RUN_LOCALE="-Duser.language=en -Duser.country=US"
$ java $RUN_LOCALE -jar checkstyle-10.26.1-all.jar -c config.xml WithNative.java
Starting audit...
[ERROR] D:\temp\checkstyle\WithNative.java:8:8: Unused @param tag for 'chartComponent'. [JavadocType]
Audit done.
Checkstyle ends with 1 errors.

Describe what you expect in detail.
Method createPlugin has proper javadoc. I expect no errors.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions