[IGNITE-14591] Add Javadoc rules to maven checkstyle plugin.

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha3
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Andrey Mashenkov
• Reporter: Andrey Mashenkov
• Reviewer: Andrey N. Gura
• Created: 19/Apr/21 09:24
• Updated: 22/Jul/21 10:45
• Resolved: 19/Jul/21 14:33

Description

Motivation.

For now, we have a Javadoc suite on TC which runs javadoc tool as it is done for releases for javadoc generation purposes.
Using this tool helps us to detect a markup error in the resulting HTML code at the early stage.
However, it treats style violations as just a WARNING which never make the TC task failed.

We tried to use an additional check (actually a log parsing) to fail the TC task, but now it is disabled because we can't perform the same checks on the user side.
Also, style checks are not configurable, so using the javadoc tool for that purpose looks useless.

Descrition.

Checkstyle plugin has a module that performs style checks for javadocs and its configuration looks flexible enough.
In opposite to javadoc tool, checkstyle plugin fails the maven task in case of style violation as on TC as on user side.

Let's

• leave current Javadoc TC suite (javadoc tool) as is with suppressing styles warnings.
• add javadoc rules to maven-checkstyle-plugin and update the Codestyle guide.

Issue Links

• causes: IGNITE-14563 Fix javadoc in Runner module.
• causes: IGNITE-15150 Fix javadoc in Cli module.
• causes: IGNITE-15151 Fix javadoc in Examples module.
• causes: IGNITE-15176 Fix javadoc in Raft module.
• causes: IGNITE-15149 Fix javadoc in Configuration module.
• causes: IGNITE-15152 Fix javadoc in Api and Core modules.
• causes: IGNITE-15153 Fix javadoc in Schema and Table modules.
• causes: IGNITE-15173 Fix javadoc in Calcite module.
• causes: IGNITE-15174 Fix javadoc in Network module.
• causes: IGNITE-15175 Fix javadoc in Rest module.
• links to: Dev-list discussion on the topic.
• links to: GitHub Pull Request #98