From e95d9b668ff5d6fbc64ac13d7cd349a41367e830 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20K=C3=BChne?= Date: Tue, 27 Apr 2004 04:17:12 +0000 Subject: [PATCH] XHTML compliant javadoc --- .../checkstyle/checks/coding/FinalLocalVariableCheck.java | 2 +- .../tools/checkstyle/checks/coding/IllegalTokenCheck.java | 3 ++- .../checkstyle/checks/coding/IllegalTokenTextCheck.java | 2 ++ .../checkstyle/checks/coding/InnerAssignmentCheck.java | 1 + .../checkstyle/checks/javadoc/JavadocStyleCheck.java | 8 +++++--- .../checks/whitespace/EmptyForInitializerPadCheck.java | 4 ++-- 6 files changed, 13 insertions(+), 7 deletions(-) diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java index cd49a8ae5..f2bec517f 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java @@ -37,7 +37,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * 
  * <module name="FinalLocalVariable">
  *     <property name="token" value="VARIABLE_DEF"/>
- * </module>
+ * </module>
  *
* @author k_gibbs, r_auckenthaler */ diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenCheck.java index 74ce39836..4bfffafc5 100644 --- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenCheck.java +++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenCheck.java @@ -41,8 +41,9 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * 
  * <module name="IllegalToken"/>
  *
- * *

An example of how to configure the check to forbid + *

An example of how to configure the check to forbid * a {@link TokenTypes#LITERAL_NATIVE LITERAL_NATIVE} token is: + *

* 
  * <module name="IllegalToken">
  *     <property name="tokens" value="LITERAL_NATIVE"/>
diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.java
index 3ab7762b0..1fec8a787 100644
--- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.java
+++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.java
@@ -31,6 +31,7 @@ import com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck;
  * 

  * 
 An example of how to configure the check to forbid String literals
  * containing "a href" is:
+ * 

  * 
  * <module name="IllegalTokenText">
  *     <property name="tokens" value="STRING_LITERAL"/>
@@ -39,6 +40,7 @@ import com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck;
  * 

  * 
 An example of how to configure the check to forbid leading zeros in an
  * integer literal, other than zero and a hex literal is:
+ * 

  * 
  * <module name="IllegalTokenText">
  *     <property name="tokens" value="NUM_INT,NUM_LONG"/>
diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java
index 6de878600..368e5c604 100644
--- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java
+++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java
@@ -50,6 +50,7 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
  *  {@link TokenTypes#STAR_ASSIGN STAR_ASSIGN}.
  * 

  * 
 An example of how to configure the check is:
+ * 

  * 
  * <module name="InnerAssignment"/>
  * 

diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java
index 8761bfbaa..2f6bee505 100755
--- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java
+++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java
@@ -33,21 +33,23 @@ import org.apache.regexp.RESyntaxException;
 /**
  * 
Custom Checkstyle Check to validate Javadoc.
  * The following checks are performed:
+ * 

  * 
    
  * 
  • 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.
    • 
  * 
  •  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.
    • 
  * 
  • 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.
    • 
  * 

  * 
These checks were patterned after the checks made by the doclet
  * com.sun.tools.doclets.doccheck.DocCheck
+ * 

  *
  * @author Chris Stillwell
  * @author Daniel Grenner
diff --git a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java
index c9acecff7..d7b3515cd 100644
--- a/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java
+++ b/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyForInitializerPadCheck.java
@@ -32,7 +32,7 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractOption;
  * 

  * 
 for (
-      ; i < j; i++, j--)
+      ; i < j; i++, j--)
    

  * 

  * The policy to verify is specified using the {@link PadOption} class and
@@ -44,7 +44,7 @@ for (
  * 
  * <module name="EmptyForInitializerPad"/>
  * 

- * 

+ *
  * @author lkuehne
  * @version 1.0
  */