TouchInstinct
/
checkstyle
307
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix for javadoc problems acording to java8

This commit is contained in:
Roman Ivanov 2014-08-25 18:16:38 -07:00
parent bb43ff2afd
commit 465efcd6e0
22 changed files with 76 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/com/puppycrawl/tools/checkstyle/Checker.java
View File

@ -323,7 +323,7 @@ public class Checker extends AutomaticBean implements MessageDispatcher
* <li>DOS style paths that start with a drive letter will have
* \ as the separator.</li>
* </ul>
* </p>
* <p>
*
* @param aPath a path for &quot;normalizing&quot;
* @return &quot;normalized&quot; file name

2
src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java
View File

@ -158,7 +158,7 @@ public class XMLLogger
}
/**
* Escape &lt;, &gt; &amp; &apos; and &quot; as their entities.
* Escape &lt;, &gt; &amp; &#39; and &quot; as their entities.
* @param aValue the value to escape.
* @return the escaped value if necessary.
*/

2
src/main/java/com/puppycrawl/tools/checkstyle/api/Check.java
View File

@ -26,7 +26,7 @@ import java.util.Set;
*
* @author Oliver Burn
* @version 1.0
* @see <a href="./{@docRoot}/../writingchecks.html" target="_top">Writing
* @see <a href="{@docRoot}/../writingchecks.html" target="_top">Writing
* your own checks</a>
*/
public abstract class Check extends AbstractViolationReporter

28
src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java
View File

@ -501,8 +501,8 @@ public final class TokenTypes
* is an optional identifier.
*
* <p>For example:</p>
* <pre>
* </pre>
*
*
* <p>parses as:</p>
* <pre>
* +--EXTENDS_CLAUSE
@ -723,7 +723,7 @@ public final class TokenTypes
* +--ELIST
* +--RPAREN ())
* </pre>
* </p>
*
*
* @see #IDENT
* @see #TYPE_ARGUMENTS
@ -1692,7 +1692,7 @@ public final class TokenTypes
* {
* x = rand.nextInt(10);
* }
* while(x < 5);
* while(x &lt; 5);
* </pre>
* <p>parses as:</p>
* <pre>
@ -1722,7 +1722,7 @@ public final class TokenTypes
* +--LPAREN (()
* +--EXPR
* |
* +--LT (<)
* +--LT (&lt;)
* |
* +--IDENT (x)
* +--NUM_INT (5)
@ -2253,7 +2253,7 @@ public final class TokenTypes
**/
public static final int LOR = GeneratedJavaTokenTypes.LOR;
/**
* The <code>&&</code> (conditional AND) operator.
* The <code>&amp;&amp;</code> (conditional AND) operator.
*
* @see <a
* href="http://java.sun.com/docs/books/jls/second_edition/html/expressions.doc.html#5247">Java
@ -2280,7 +2280,7 @@ public final class TokenTypes
**/
public static final int BXOR = GeneratedJavaTokenTypes.BXOR;
/**
* The <code>&</code> (bitwise AND) operator.
* The <code>&amp;</code> (bitwise AND) operator.
*
* @see <a
* href="http://java.sun.com/docs/books/jls/second_edition/html/expressions.doc.html#5233">Java
@ -3207,7 +3207,7 @@ public final class TokenTypes
* +--IDENT (Blah)
* +--TYPE_PARAMETERS
* |
* +--GENERIC_START (<)
* +--GENERIC_START (&lt;)
* +--TYPE_PARAMETER
* |
* +--IDENT (A)
@ -3215,7 +3215,7 @@ public final class TokenTypes
* +--TYPE_PARAMETER
* |
* +--IDENT (B)
* +--GENERIC_END (>)
* +--GENERIC_END (&gt;)
* +--OBJBLOCK
* |
* +--LCURLY ({)
@ -3274,7 +3274,7 @@ public final class TokenTypes
* <p>For example:</p>
*
* <pre>
* public Collection<?> a;
* public Collection&lt;?&gt; a;
* </pre>
*
* <p>parses as:</p>
@ -3291,11 +3291,11 @@ public final class TokenTypes
* |
* +--TYPE_ARGUMENTS
* |
* +--GENERIC_START (<)
* +--GENERIC_START (&lt;)
* +--TYPE_ARGUMENT
* |
* +--WILDCARD_TYPE (?)
* +--GENERIC_END (>)
* +--GENERIC_END (&gt;)
* +--IDENT (a)
* +--SEMI (;)
* </pre>
@ -3397,8 +3397,8 @@ public final class TokenTypes
public static final int ELLIPSIS = GeneratedJavaTokenTypes.ELLIPSIS;
/**
* '&' symbol when used in a generic upper or lower bounds constrain
* e.g. {@code Comparable<? extends Serializable, CharSequence>}.
* '&amp;' symbol when used in a generic upper or lower bounds constrain
* e.g. {@code Comparable&lt;<? extends Serializable, CharSequence>}.
*/
public static final int TYPE_EXTENSION_AND =
GeneratedJavaTokenTypes.TYPE_EXTENSION_AND;

4
src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java
View File

@ -86,7 +86,7 @@ import org.apache.commons.beanutils.ConversionException;
* His comments on being hard to maintain when the size of
* the line changes are even more important in the age of
* automated refactorings.
* </p>
*
* <p>
* To configure the check so it enforces only comment on a line:
* <pre>
@ -94,7 +94,7 @@ import org.apache.commons.beanutils.ConversionException;
* &lt;property name=&quot;format&quot; value=&quot;^\\s*$&quot;/&gt;
* &lt;/module&gt;
* </pre>
* </p>
*
* @author o_sukhodolsky
*/
public class TrailingCommentCheck extends AbstractFormatCheck

3
src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java
View File

@ -34,7 +34,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* Rationale: The letter <span class="code">l</span> looks a lot
* like the number <span class="code">1</span>.
* </p>
* <h4>Examples</h4>
*
* Examples
* <p class="body">
* To configure the check:
*

22
src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java
View File

@ -37,18 +37,18 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* To not enforce an element style
* a {@link ElementStyle#IGNORE IGNORE} type is provided. The desired style
* can be set through the <code>elementStyle</code> property.
* </p>
*
*
* <p>
* Using the EXPANDED style is more verbose. The expanded version
* is sometimes referred to as "named parameters" in other languages.
* </p>
*
*
* <p>
* Using the COMPACT style is less verbose. This style can only
* be used when there is an element called 'value' which is either
* the sole element or all other elements have default valuess.
* </p>
*
*
* <p>
* Using the COMPACT_NO_ARRAY style is less verbose. It is similar
@ -57,7 +57,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* array initializer. This style can only be used when there is an
* element called 'value' which is either the sole element or all other
* elements have default values.
* </p>
*
*
* <p>
* The ending parenthesis are optional when using annotations with no elements.
@ -66,7 +66,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* use the {@link ClosingParens#NEVER NEVER} type. To not enforce a
* closing parenthesis preference a {@link ClosingParens#IGNORE IGNORE} type is
* provided. Set this through the <code>closingParens</code> property.
* </p>
*
*
* <p>
* Annotations also allow you to specify arrays of elements in a standard
@ -76,16 +76,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* {@link TrailingArrayComma#NEVER NEVER} type. To not enforce a trailing
* array comma preference a {@link TrailingArrayComma#IGNORE IGNORE} type
* is provided. Set this through the <code>trailingArrayComma</code> property.
* </p>
*
*
* <p>
* By default the ElementStyle is set to EXPANDED, the TrailingArrayComma
* is set to NEVER, and the ClosingParans is set to ALWAYS.
* </p>
*
*
* <p>
* According to the JLS, it is legal to include a trailing comma
* in arrays used in annotations but Sun's Java 5 & 6 compilers will not
* in arrays used in annotations but Sun's Java 5 &amp; 6 compilers will not
* compile with this syntax. This may in be a bug in Sun's compilers
* since eclipse 3.4's built-in compiler does allow this syntax as
* defined in the JLS. Note: this was tested with compilers included with
@ -95,13 +95,13 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* See <a
* href="http://java.sun.com/docs/books/jls/third_edition/html/j3TOC.html">
* Java Language specification, sections 9.7</a>.
* </p>
*
*
* <p>
* An example shown below is set to enforce an EXPANDED style, with a
* trailing array comma set to NEVER and always including the closing
* parenthesis.
* </p>
*
*
* <pre>
* &lt;module name=&quot;AnnotationUseStyle&quot;&gt;
@ -439,7 +439,7 @@ public final class AnnotationUseStyleCheck extends Check
* compact example
*
* <pre>@SuppressWarnings({"unchecked","unused",})</pre>
* <br/>or<br/>
* <br>or<br>
* <pre>@SuppressWarnings("unchecked")</pre>.
*/
COMPACT,

2
src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java
View File

@ -54,7 +54,7 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
*
* <p>
* Limitations: This check does not consider conditionals
* inside the SuppressWarnings annotation. <br/>
* inside the SuppressWarnings annotation. <br>
* For example:
* {@code @SuppressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused")}
* According to the above example, the "unused" warning is being suppressed

6
src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java
View File

@ -52,12 +52,12 @@ public enum LeftCurlyOption
* But for a statement spanning multiple lines, Checkstyle will enforce:
*
* <pre>
* if (condition1 && condition2 &&
* condition3 && condition4)
* if (condition1 &amp;&amp; condition2 &amp;&amp;
* condition3 &amp;&amp; condition4)
* {
* ...
* </pre>
* </p>
*
**/
NLOW,

8
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java
View File

@ -32,8 +32,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <a
* href="http://java.sun.com/docs/codeconv/html/CodeConventions.doc2.html#1852"
* >Code Conventions for the Java Programming Language</a>.
* </p>
* <p>
*
*
* <ol>
* <li> Class (static) variables. First the public class variables, then
* the protected, then package level (no access modifier), and then
@ -44,10 +44,10 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <li> Constructors </li>
* <li> Methods </li>
* </ol>
* </p>
*
* <p>
* An example of how to configure the check is:
* </p>
*
* <pre>
* &lt;module name="DeclarationOrder"/&gt;
* </pre>

8
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java
View File

@ -52,7 +52,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* &quot;My_Sweet_String&quot;.equals(nullString);
* </code>
* </pre>
* </p>
*
*
* <p>
* Limitations: If the equals method is overridden or
@ -61,7 +61,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* as t.equals(s)) then rearranging the called on object and
* parameter may have unexpected results
*
* <br/>
* <br>
*
* Java's Autoboxing feature has an affect
* on how this check is implemented. Pre Java 5 all IDENT + IDENT
@ -69,7 +69,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* if null. Those situations could have been included in this check.
* They would simply act as if they surrounded by String.valueOf()
* which would concatenate the String null.
* </p>
*
* <p>
* The following example will cause a
* NullPointerException as a result of what autoboxing does.
@ -78,7 +78,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* String number = "5"
* number.equals(i + j);
* </pre>
* </p>
*
*
* Since, it is difficult to determine what kind of Object is being
* concatenated all ident concatenation is considered unsafe.

8
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java
View File

@ -67,7 +67,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
* provide a correct clone implementation.
* </li>
* </ul>
* </p>
*
*
* <p>
* Two alternatives to the clone method, in some cases, is a copy constructor
@ -76,7 +76,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
* force the calling client to handle a CloneNotSupportedException. They also
* are typed therefore no casting is necessary. Finally, they are more
* flexible since they can take interface types rather than concrete classes.
* </p>
*
*
* <p>
* Sometimes a copy constructor or static factory is not an acceptable
@ -108,7 +108,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
*
* Just keep in mind if this type of polymorphic cloning is required
* then a properly implemented clone method may be the best choice.
* </p>
*
*
* <p>
* Much of this information was taken from Effective Java:
@ -118,7 +118,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
*
* <p>
* This check is almost exactly the same as the {@link NoFinalizerCheck}
* </p>
*
*
* @author Travis Schneeberger
* @version 1.0

2
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java
View File

@ -41,7 +41,7 @@ import com.puppycrawl.tools.checkstyle.checks.DeclarationCollector;
* &lt;property name=&quot;checkMethods&quot; value=&quot;true&quot;/&gt;
* &lt;/module&gt;
* </pre>
* </p>
*
* <p>Limitations: I'm not currently doing anything about static variables
* or catch-blocks. Static methods invoked on a class name seem to be OK;
* both the class name and the method name have a DOT parent.

8
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java
View File

@ -72,7 +72,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* The distance for the variable <b>minutes</b> is 1 even
* though this variable is used in the fifth method's call.
* </pre>
* </p>
*
* <p>
* <b>Case #2:</b>
* <pre>
@ -88,7 +88,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* The distance for the variable <b>minutes</b> is 6 because there is one more expression
* (except the initialization block) between the declaration of this variable and its usage.
* </pre>
* </p>
*
*
* There are several additional options to configure the check:
* <pre>
@ -122,11 +122,11 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <pre>
* Case #2:
* <code>int sum = 0;
* for (int i = 0; i < 20; i++) {
* for (int i = 0; i &lt; 20; i++) {
* a++;
* b--;
* sum++;
* if (sum > 10) {
* if (sum &gt; 10) {
* res = true;
* }
* }</code>

2
src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java
View File

@ -42,7 +42,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <li>final or</li>
* <li>have an empty implementation</li>
* </ul>
* </p>
*
*
* <p>
* This protects superclasses against being broken by

4
src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java
View File

@ -27,7 +27,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* The "block" handler classes use a common superclass BlockParentHandler,
* employing the Template Method pattern.
* </P>
* <P>
*
* <UL>
* <LI>template method to get the lcurly</LI>
* <LI>template method to get the rcurly</LI>
@ -36,7 +36,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <LI>now all the repetitous code which checks for BOL, if curlys are on
* same line, etc. can be collapsed into the superclass</LI>
* </UL>
* </P>
*
*
* @author jrichard
*/

2
src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java
View File

@ -88,7 +88,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* and immediate children.
* </p>
* <pre>
* - handler class -to-> ID mapping kept in Map
* - handler class -to-&gt; ID mapping kept in Map
* - parent passed in during construction
* - suggest child indent level
* - allows for some tokens to be on same line (ie inner classes OBJBLOCK)

2
src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java
View File

@ -40,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* <li>applyToPackage, default true;</li>
* <li>applyToPrivate, default true;</li>
* </ol>
* </p>
*
*
* @author Rick Giles
* @version 1.0

3
src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/NoLineWrapCheck.java
View File

@ -27,7 +27,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* By default this Check restricts wrapping import and package statements,
* but it's possible to check any statement.
* </p>
* <h4>Examples</h4>
*
* Examples
* <p class="body">
*
* Examples of line-wrapped statements (bad case):

28
src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java
View File

@ -98,7 +98,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* In addition, this check can be configured to allow empty methods, types,
* for, while, do-while loops and constructor bodies.
* For example:
* </p>
*
* <p>
* <pre><code>
* public MyClass() {} // empty constructor
@ -108,46 +108,46 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* public enum Foo {} // empty enum
* MyClass c = new MyClass() {}; // empty anonymous class
* while (i = 1) {} // empty while loop
* for (int i = 1; i > 1; i++) {} // empty for loop
* for (int i = 1; i &gt; 1; i++) {} // empty for loop
* do {} while (i = 1); // empty do-while loop
* public @interface Beta {} // empty annotation type
* </code></pre>
* </p>
*
* <p>
* To configure the check to allow empty method blocks use
* </p>
*
* <p>
* <pre> &lt;property name="allowEmptyMethods" value="true" /&gt;</pre>
* </p>
*
* <p>
* To configure the check to allow empty constructor blocks use
* </p>
*
* <p>
* <pre> &lt;property name="allowEmptyConstructors" value="true" /&gt;</pre>
* </p>
*
* <p>
* To configure the check to allow empty type blocks use
* </p>
*
* <p>
* <pre> &lt;property name="allowEmptyTypes" value="true" /&gt;</pre>
* </p>
*
* <p>
* To configure the check to allow empty loop blocks use
* </p>
*
* <p>
* <pre> &lt;property name="allowEmptyLoops" value="true" /&gt;</pre>
* </p>
*
*
* <p>
* Also, this check can be configured to ignore the colon in an enhanced for
* loop. The colon in an enhanced for loop is ignored by default
* </p>
*
* <p>
* To configure the check to ignore the colon
* </p>
*
* <p>
* <pre> &lt;property name="ignoreEnhancedForColon" value="true" /&gt;</pre>
* </p>
*
*
* @author Oliver Burn
* @author maxvetrenko

4
src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java
View File

@ -65,10 +65,10 @@ import org.apache.commons.beanutils.ConversionException;
* ...
* }
* </pre>
* </p>
*
* <p>
* See {@link SuppressionCommentFilter} for usage notes.
* </p>
*
*
* @author Mick Killianey
*/

1
src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeInfoPanel.java
View File

@ -223,7 +223,6 @@ public class ParseTreeInfoPanel extends JPanel
* Parses a file and returns the parse tree.
* @param aText the file to parse
* @return the root node of the parse tree
* @throws IOException if the file cannot be opened
* @throws ANTLRException if the file is not a Java source
*/
public static DetailAST parseFile(FileText aText)