[
https://issues.apache.org/jira/browse/IGNITE-14591?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17383379#comment-17383379
]
Andrey Mashenkov edited comment on IGNITE-14591 at 7/19/21, 2:33 PM:
---------------------------------------------------------------------
Unfortunately, it is impossible to have different style policies for different
cod parts.
So, as decided on dev-list, new rules for public API added for now, see:
check-rules/checkstyle-public-api-javadoc.xml
Modules with broken styles are added to the exclude-list and will be fixed
within separate tasks:
check-rules/checkstyle-disabled-modules.xml
was (Author: amashenkov):
Unfortunately, it is impossible to have different style policies for different
cod parts.
So, as decided on dev-list new rules for public API added at first, see:
check-rules/checkstyle-public-api-javadoc.xml
Modules with broken styles are added to the exclude-list and will be fixed
within separate tasks:
check-rules/checkstyle-disabled-modules.xml
> Add Javadoc rules to maven checkstyle plugin.
> ---------------------------------------------
>
> Key: IGNITE-14591
> URL: https://issues.apache.org/jira/browse/IGNITE-14591
> Project: Ignite
> Issue Type: Improvement
> Reporter: Andrey Mashenkov
> Assignee: Andrey Mashenkov
> Priority: Major
> Labels: ignite-3
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> h3. 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.
> h3. 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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
