From 638dfe14bc7ff0fa358e9531ded468f245c389fd Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Sun, 7 Sep 2014 21:35:24 -0700 Subject: [PATCH] fixes for javadoc problems that are found by java8 --- .../whitespace/GenericWhitespaceCheck.java | 22 +++++++++---------- .../whitespace/WhitespaceAroundCheck.java | 10 +++++---- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java index 99e923ce1..5081b8506 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/GenericWhitespaceCheck.java @@ -29,11 +29,11 @@ import com.puppycrawl.tools.checkstyle.api.Utils; * "<" and ">" are correct to the typical convention. * The convention is not configurable. *

- *
+ *
*

* Left angle bracket ("<"): *

- *
+ *
* - *
+ *
*

* Right angle bracket (">"): *

- *
+ *
* - *
+ *
*

* Examples with correct spacing: *

- *
+ *
* 
- * public void <K, V extends Number> boolean foo(K, V) {} // Generic methods definitions
- * class name<T1, T2, ..., Tn> {}                         // Generic type definition
- * OrderedPair<String, Box<Integer>> p;             // Generic type reference
- * boolean same = Util.<Integer, String>compare(p1, p2);  // Generic preceded method name
- * Pair<Integer, String> p1 = new Pair<>(1, "apple");  // Diamond operator
+ * public void <K, V extends Number> boolean foo(K, V) {}  // Generic methods definitions
+ * class name<T1, T2, ..., Tn> {}                          // Generic type definition
+ * OrderedPair<String, Box<Integer>> p;              // Generic type reference
+ * boolean same = Util.<Integer, String>compare(p1, p2);   // Generic preceded method name
+ * Pair<Integer, String> p1 = new Pair<>(1, "apple");// Diamond operator
  *
* @author Oliver Burn */ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java index 8b9b965b0..0d7e3f821 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java @@ -25,7 +25,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** *

* Checks that a token is surrounded by whitespace. - *

+ * *

By default the check will check the following operators: * {@link TokenTypes#LITERAL_ASSERT ASSERT}, * {@link TokenTypes#ASSIGN ASSIGN}, @@ -78,22 +78,24 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * {@link TokenTypes#STAR_ASSIGN STAR_ASSIGN}, * {@link TokenTypes#LITERAL_ASSERT LITERAL_ASSERT}, * {@link TokenTypes#TYPE_EXTENSION_AND TYPE_EXTENSION_AND}. - *

+ * *

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

+ * * 
  * <module name="WhitespaceAround"/>
  *
+ * *

An example of how to configure the check for whitespace only around * assignment operators is: - *

+ * * 
  * <module name="WhitespaceAround">
  *     <property name="tokens"
  *               value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/>
  * </module>
  *
+ * *

* In addition, this check can be configured to allow empty methods, types, * for, while, do-while loops and constructor bodies.