You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Mikhail Petrov (Jira)" <ji...@apache.org> on 2021/09/07 15:05:00 UTC
[jira] [Updated] (IGNITE-15467) Add JavaDoc code style rules for
maven checkstyle plugin.
[ https://issues.apache.org/jira/browse/IGNITE-15467?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mikhail Petrov updated IGNITE-15467:
------------------------------------
Description:
It is proposed to add the following JavaDoc code style checks for maven checkstyle plugin -
{code:java}
<module name="MissingJavadocMethod">
<property name="scope" value="private"/>
<property name="allowedAnnotations" value="{}"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
</module>
<module name="MissingJavadocType">
<property name="scope" value="private"/>
</module>
<module name="JavadocVariable"/>
{code}
Current ticket does not include method JavaDoc content check for ml, test, yardstic and internal packages.
was:
It is proposed to add the following JavaDoc code style checks -
{code:java}
<module name="MissingJavadocMethod">
<property name="scope" value="private"/>
<property name="allowedAnnotations" value="{}"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
</module>
<module name="MissingJavadocType">
<property name="scope" value="private"/>
</module>
<module name="JavadocVariable"/>
{code}
Current ticket does not include method JavaDoc content check for ml, test, yardstic and internal packages.
Summary: Add JavaDoc code style rules for maven checkstyle plugin. (was: Add JavaDoc code style rules.)
> Add JavaDoc code style rules for maven checkstyle plugin.
> ---------------------------------------------------------
>
> Key: IGNITE-15467
> URL: https://issues.apache.org/jira/browse/IGNITE-15467
> Project: Ignite
> Issue Type: Improvement
> Reporter: Mikhail Petrov
> Assignee: Mikhail Petrov
> Priority: Trivial
>
> It is proposed to add the following JavaDoc code style checks for maven checkstyle plugin -
> {code:java}
> <module name="MissingJavadocMethod">
> <property name="scope" value="private"/>
> <property name="allowedAnnotations" value="{}"/>
> </module>
> <module name="JavadocMethod">
> <property name="scope" value="public"/>
> </module>
> <module name="MissingJavadocType">
> <property name="scope" value="private"/>
> </module>
> <module name="JavadocVariable"/>
> {code}
> Current ticket does not include method JavaDoc content check for ml, test, yardstic and internal packages.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)