[IGNITE-13751] Add javadoc validation to sanity check.

• Type: Improvement
• Status: Resolved
• Priority: Critical
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha2
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Petr Ivanov
• Reporter: Andrey Mashenkov
• Created: 24/Nov/20 12:16
• Updated: 22/Jul/21 10:41
• Resolved: 15/Apr/21 16:48

Description

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.
   

Issue Links

• causes: IGNITE-14563 Fix javadoc in Runner module.
• causes: IGNITE-14559 Fix javadoc in schema and table modules.
• causes: IGNITE-14560 Fix javadoc in CLI and Rest modules.
• causes: IGNITE-14561 Fix javadoc in Configuration module.
• causes: IGNITE-14562 Fix javadoc in Network module.
• causes: IGNITE-14558 Add information about javadoc validation and generation commands to DEVNOTES.md
• duplicates: IGNITE-13874 Add PMD and idea inspections to Ignite-3 build cycle
• links to: [Apache Ignite 3.x] / [Test] / [Sanity Checks] / Javadoc
• links to: GitHub Pull Request #93