[jira] [Comment Edited] (IGNITE-13751) Add javadoc validation to sanity check.

["Andrey Mashenkov (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/IGNITE-13751?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17322313#comment-17322313 ] 

Andrey Mashenkov edited comment on IGNITE-13751 at 4/15/21, 4:49 PM:
---------------------------------------------------------------------

[~vveider] , many thanks for your efforts!

Merged to master.
 Hope our code will be well-documented since now.


was (Author: amashenkov):
[~vveider] , many thanks for your efforts!

Merged to master.
Hope your code will be well-documented now.

> Add javadoc validation to sanity check.
> ---------------------------------------
>
>                 Key: IGNITE-13751
>                 URL: https://issues.apache.org/jira/browse/IGNITE-13751
>             Project: Ignite
>          Issue Type: Improvement
>            Reporter: Andrey Mashenkov
>            Assignee: Peter Ivanov
>            Priority: Critical
>              Labels: ignite-3
>             Fix For: 3.0.0-alpha2
>
>          Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> Let's add javadoc validation plugin for sanity checks and make it run on TC.
> We have to be able to  validate javadocs for test purposes and build javadoc.jar along with site for release purposes.
> For tests:
> * Validate javadocs in all the packages of all the modules (excepts 'bytecode'). 
> * No site generation is expected at all.
> For release:
> * Compile javadocs into javadoc.jar per-module with the public packages only ('org.apache.ignite.\*', but 'org.apache.ignite.internal.\*') to developers can download docs (as well as sources) from the maven.
> No site generation on per-module basis is expected.
> * Build a site with aggregated javadocs once.
>  



--
This message was sent by Atlassian Jira
(v8.3.4#803005)