additional fixed for javadoc/xdoc of SingleLineJavadocCheck

This commit is contained in:
Roman Ivanov 2014-10-23 07:57:29 -07:00
parent 0e90cc00c8
commit 8aa747f8ac
3 changed files with 6 additions and 3 deletions

View File

@ -24,7 +24,8 @@ import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes;
/**
* Checks that a JavaDoc block which can fit on a single line and doesn't
* contain at-clauses may be substituted by a single line.
* contain at-clauses. Javadoc comment that contains at leat one at-clause
* should be formatted in few lines.
*
* Default configuration:
* <pre>

View File

@ -642,7 +642,7 @@
<tr>
<td><a href="config_javadoc.html#SingleLineJavadoc">SingleLineJavadoc</a></td>
<td>
Checks that a JavaDoc block which can fit on a single line.</td>
Checks that a JavaDoc block which can fit on a single line and doesn't contain at-clauses</td>
</tr>
<tr>
<td><a href="config_coding.html#SimplifyBooleanExpression">SimplifyBooleanExpression</a></td>

View File

@ -1098,7 +1098,9 @@ public boolean isSomething()
<section name="SingleLineJavadoc">
<subsection name="Description">
<p>
Checks that a JavaDoc block which can fit on a single line and doesn't contain at-clauses may be substituted by a single line.
Checks that a JavaDoc block which can fit on a single line and doesn't
contain at-clauses. Javadoc comment that contains at leat one at-clause
should be formatted in few lines.
</p>
</subsection>