Issue checkstyle#6929: fix violations for JavadocBlockTagLocation

rnveach · Aug 2, 2019 · ace12fe · ace12fe
1 parent 23aa86c
commit ace12fe
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 13 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java
@@ -35,7 +35,7 @@ public final class JavadocTokenTypes {
     //--------------------------------------------------------------------------------------------//
 
     /**
-     * '@return' literal in @return Javadoc tag.
+     * '@return' literal in {@code @return} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
      *
@@ -81,7 +81,7 @@ public final class JavadocTokenTypes {
     public static final int DEPRECATED_LITERAL = JavadocParser.DEPRECATED_LITERAL;
 
     /**
-     * '@since' literal in @since Javadoc tag.
+     * '@since' literal in {@code @since} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
      *
@@ -104,7 +104,7 @@ public final class JavadocTokenTypes {
     public static final int SINCE_LITERAL = JavadocParser.SINCE_LITERAL;
 
     /**
-     * '@serialData' literal in @serialData Javadoc tag.
+     * '@serialData' literal in {@code @serialData} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
      *
@@ -128,7 +128,7 @@ public final class JavadocTokenTypes {
     public static final int SERIAL_DATA_LITERAL = JavadocParser.SERIAL_DATA_LITERAL;
 
     /**
-     * '@serialField' literal in @serialField Javadoc tag.
+     * '@serialField' literal in {@code @serialField} Javadoc tag.
      *
      * <p>Such Javadoc tag can have three arguments:</p>
      * <ol>
@@ -160,7 +160,7 @@ public final class JavadocTokenTypes {
     public static final int SERIAL_FIELD_LITERAL = JavadocParser.SERIAL_FIELD_LITERAL;
 
     /**
-     * '@param' literal in @param Javadoc tag.
+     * '@param' literal in {@code @param} Javadoc tag.
      *
      * <p>Such Javadoc tag can have two arguments:</p>
      * <ol>
@@ -189,7 +189,7 @@ public final class JavadocTokenTypes {
     public static final int PARAM_LITERAL = JavadocParser.PARAM_LITERAL;
 
     /**
-     * '@see' literal in @see Javadoc tag.
+     * '@see' literal in {@code @see} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #REFERENCE}</p>
      *
@@ -222,7 +222,7 @@ public final class JavadocTokenTypes {
     public static final int SEE_LITERAL = JavadocParser.SEE_LITERAL;
 
     /**
-     * '@serial' literal in @serial Javadoc tag.
+     * '@serial' literal in {@code @serial} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #REFERENCE} or {@link #LITERAL_EXCLUDE}
      * or {@link #LITERAL_INCLUDE}</p>
@@ -256,7 +256,7 @@ public final class JavadocTokenTypes {
     public static final int SERIAL_LITERAL = JavadocParser.SERIAL_LITERAL;
 
     /**
-     * '@version' literal in @version Javadoc tag.
+     * '@version' literal in {@code @version} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
      *
@@ -279,7 +279,7 @@ public final class JavadocTokenTypes {
     public static final int VERSION_LITERAL = JavadocParser.VERSION_LITERAL;
 
     /**
-     * '@exception' literal in @exception Javadoc tag.
+     * '@exception' literal in {@code @exception} Javadoc tag.
      *
      * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
      *
@@ -304,7 +304,7 @@ public final class JavadocTokenTypes {
     public static final int EXCEPTION_LITERAL = JavadocParser.EXCEPTION_LITERAL;
 
     /**
-     * '@throws' literal in @throws Javadoc tag.
+     * '@throws' literal in {@code @throws} Javadoc tag.
      *
      * <p>Such Javadoc tag can have two argument - {@link #CLASS_NAME} and {@link #DESCRIPTION}</p>
      *
@@ -329,7 +329,7 @@ public final class JavadocTokenTypes {
     public static final int THROWS_LITERAL = JavadocParser.THROWS_LITERAL;
 
     /**
-     * '@author' literal in @author Javadoc tag.
+     * '@author' literal in {@code @author} Javadoc tag.
      *
      * <p>Such Javadoc tag can have one argument - {@link #DESCRIPTION}</p>
      *
@@ -850,7 +850,7 @@ public final class JavadocTokenTypes {
 
     /**
      * Quoted text.
-     * One of possible @see tag arguments.
+     * One of possible {@code @see} tag arguments.
      *
      * <p><b>Example:</b></p>
      * <pre>{@code @see "Spring Framework"}</pre>

diff --git a/...main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java b/...main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java
@@ -293,7 +293,9 @@
  *   STATE CHAR(2),
  *   LAT_N REAL,
  *   LONG_W REAL);
- * </pre> @since 8.6
+ * </pre>
+ *
+ * @since 8.6
  */
 public class SuppressWithPlainTextCommentFilter extends AutomaticBean implements Filter {