Maxim Muzafarov created IGNITE-11903:
----------------------------------------
Summary: Checkstyle must support to JavadocStyle rule
Key: IGNITE-11903
URL: https://issues.apache.org/jira/browse/IGNITE-11903
Project: Ignite
Issue Type: Bug
Reporter: Maxim Muzafarov
Add support to <module name="JavadocStyle"/> to checkstyle plugin. Analyze and
set the best-fit configuration properties for the Apache Ignite needs.
[http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle]
{noformat}
Validates Javadoc comments to help ensure they are well formed. The following
checks are performed:
Ensures the first sentence ends with proper punctuation (That is a period,
question mark, or exclamation mark, by default). Javadoc automatically places
the first sentence in the method summary table and index. Without proper
punctuation the Javadoc may be malformed. All items eligible for the
{@inheritDoc} tag are exempt from this requirement.
Check text for Javadoc statements that do not have any description. This
includes both completely empty Javadoc, and Javadoc with only tags such as
@param and @return.
Check text for incomplete HTML tags. Verifies that HTML tags have corresponding
end tags and issues an "Unclosed HTML tag found:" error if not. An "Extra HTML
tag found:" error is issued if an end tag is found without a previous open tag.
Check that a package Javadoc comment is well-formed (as described above) and
NOT missing from any package-info.java files.
Check for allowed HTML tags. The list of allowed HTML tags is "a", "abbr",
"acronym", "address", "area", "b", "bdo", "big", "blockquote", "br", "caption",
"cite", "code", "colgroup", "dd", "del", "div", "dfn", "dl", "dt", "em",
"fieldset", "font", "h1" to "h6", "hr", "i", "img", "ins", "kbd", "li", "ol",
"p", "pre", "q", "samp", "small", "span", "strong", "sub", "sup", "table",
"tbody", "td", "tfoot", "th", "thread", "tr", "tt", "u", "ul".
{noformat}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
