You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Maxim Muzafarov (Jira)" <ji...@apache.org> on 2021/09/09 17:12:00 UTC
[jira] [Commented] (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:comment-tabpanel&focusedCommentId=17412713#comment-17412713 ]
Maxim Muzafarov commented on IGNITE-15467:
------------------------------------------
Merged to the master branch. [~PetrovMikhail] Thank you for the contribution.
Javadoc suite run.
https://ci.ignite.apache.org/viewType.html?buildTypeId=IgniteTests24Java8_Javadoc&branch_IgniteTests24Java8=pull%2F9383%2Fhead&tab=buildTypeStatusDiv
> 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
> Labels: checkstyle
> Fix For: 2.12
>
> Time Spent: 50m
> Remaining Estimate: 0h
>
> 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)