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

[Andrey Mashenkov (Jira)]

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

Andrey Mashenkov commented on IGNITE-13751:
---

[~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)

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

[Peter Ivanov (Jira)]

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

Peter Ivanov commented on IGNITE-13751:
---

[Apache Ignite 3.x] / [Test] / [Sanity Checks] / Javadoc

> 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: 20m
>  Remaining Estimate: 0h
>
> Let's add javadoc validation plugin for sanity checks and make it run on TC.
> We need to
> 1. validate javadocs in all the packages of all the modules (excepts 
> 'bytecode') for tests purposes.
> 2. compile javadocs into javadoc.jar for all the public packages 
> ('org.apache.ignite.*', but 'org.apache.ignite.internal.*') to developers can 
> download docs (as well as sources) from the maven.
> 3. build a site with public javadocs for release process purposes.
>  



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