XHTML compliant javadoc
This commit is contained in:
parent
bb0f03b05c
commit
e95d9b668f
|
|
@ -37,7 +37,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* <pre>
|
||||
* <module name="FinalLocalVariable">
|
||||
* <property name="token" value="VARIABLE_DEF"/>
|
||||
* </module>
|
||||
* </module>
|
||||
* </pre>
|
||||
* @author k_gibbs, r_auckenthaler
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -41,8 +41,9 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
|
|||
* <pre>
|
||||
* <module name="IllegalToken"/>
|
||||
* </pre>
|
||||
* * <p> An example of how to configure the check to forbid
|
||||
* <p> An example of how to configure the check to forbid
|
||||
* a {@link TokenTypes#LITERAL_NATIVE LITERAL_NATIVE} token is:
|
||||
* </p>
|
||||
* <pre>
|
||||
* <module name="IllegalToken">
|
||||
* <property name="tokens" value="LITERAL_NATIVE"/>
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ import com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck;
|
|||
* </p>
|
||||
* <p> An example of how to configure the check to forbid String literals
|
||||
* containing <code>"a href"</code> is:
|
||||
* </p>
|
||||
* <pre>
|
||||
* <module name="IllegalTokenText">
|
||||
* <property name="tokens" value="STRING_LITERAL"/>
|
||||
|
|
@ -39,6 +40,7 @@ import com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck;
|
|||
* </pre>
|
||||
* <p> An example of how to configure the check to forbid leading zeros in an
|
||||
* integer literal, other than zero and a hex literal is:
|
||||
* </p>
|
||||
* <pre>
|
||||
* <module name="IllegalTokenText">
|
||||
* <property name="tokens" value="NUM_INT,NUM_LONG"/>
|
||||
|
|
|
|||
|
|
@ -50,6 +50,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
|
|||
* {@link TokenTypes#STAR_ASSIGN STAR_ASSIGN}.
|
||||
* </p>
|
||||
* <p> An example of how to configure the check is:
|
||||
* </p>
|
||||
* <pre>
|
||||
* <module name="InnerAssignment"/>
|
||||
* </pre>
|
||||
|
|
|
|||
|
|
@ -33,21 +33,23 @@ import org.apache.regexp.RESyntaxException;
|
|||
/**
|
||||
* <p>Custom Checkstyle Check to validate Javadoc.
|
||||
* The following checks are performed:
|
||||
* </p>
|
||||
* <ul>
|
||||
* <li>Ensures the first sentence ends with proper punctuation (That is
|
||||
* a period, question mark, or exclaimation mark). Javadoc automatically
|
||||
* places the first sentence in the method summary table and index. With out
|
||||
* proper punctuation the Javadoc may be malformed.
|
||||
* proper punctuation the Javadoc may be malformed.</li>
|
||||
* <li> 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.
|
||||
* tags such as @param and @return.</li>
|
||||
* <li>Check text for incomplete html tags. Verifies that HTML tags have
|
||||
* corresponding end tags and issues an UNCLOSED_HTML error if not.
|
||||
* An EXTRA_HTML error is issued if an end tag is found without a previous
|
||||
* open tag.
|
||||
* open tag.</li>
|
||||
* </ul>
|
||||
* <p>These checks were patterned after the checks made by the doclet
|
||||
* <code>com.sun.tools.doclets.doccheck.DocCheck</code>
|
||||
* </p>
|
||||
*
|
||||
* @author Chris Stillwell
|
||||
* @author Daniel Grenner
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractOption;
|
|||
* </p>
|
||||
* <pre class="body">
|
||||
for (
|
||||
; i < j; i++, j--)
|
||||
; i < j; i++, j--)
|
||||
</pre>
|
||||
* <p>
|
||||
* The policy to verify is specified using the {@link PadOption} class and
|
||||
|
|
@ -44,7 +44,7 @@ for (
|
|||
* <pre>
|
||||
* <module name="EmptyForInitializerPad"/>
|
||||
* </pre>
|
||||
* <p>
|
||||
*
|
||||
* @author lkuehne
|
||||
* @version 1.0
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue