-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
SingleLineJavadocCheck.xml
38 lines (38 loc) · 1.91 KB
/
SingleLineJavadocCheck.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
<module>
<check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck"
name="SingleLineJavadoc"
parent="com.puppycrawl.tools.checkstyle.TreeWalker">
<description><p>
Checks that a Javadoc block can fit in a single-line and doesn't contain block tags.
Javadoc comment that contains at least one block tag should be formatted in a few lines.
</p></description>
<properties>
<property default-value="true" name="ignoreInlineTags" type="boolean">
<description>Control whether
<a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
inline tags</a> must be ignored.</description>
</property>
<property default-value="" name="ignoredTags" type="java.lang.String[]">
<description>Specify
<a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
block tags</a> which are ignored by the check.</description>
</property>
<property default-value="false"
name="violateExecutionOnNonTightHtml"
type="boolean">
<description>Control when to print violations
if the Javadoc being examined by this check violates the tight html rules defined at
<a href="https://checkstyle.org/writingjavadocchecks.html#Tight-HTML_rules">Tight-HTML Rules</a>.</description>
</property>
</properties>
<message-keys>
<message-key key="javadoc.missed.html.close"/>
<message-key key="javadoc.parse.rule.error"/>
<message-key key="javadoc.wrong.singleton.html.tag"/>
<message-key key="singleline.javadoc"/>
</message-keys>
</check>
</module>
</checkstyle-metadata>