Issue #5388: added exception JavaDoc block tag to NonEmptyAtclauseDes…

…criptionCheck
checkstyle · Dec 27, 2017 · d5c3d37 · d5c3d37
1 parent 1c73987
commit d5c3d37
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/...java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java b/...java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java
@@ -48,6 +48,7 @@ public int[] getDefaultJavadocTokens() {
             JavadocTokenTypes.PARAM_LITERAL,
             JavadocTokenTypes.RETURN_LITERAL,
             JavadocTokenTypes.THROWS_LITERAL,
+            JavadocTokenTypes.EXCEPTION_LITERAL,
             JavadocTokenTypes.DEPRECATED_LITERAL,
         };
     }

diff --git a/.../com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java b/.../com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java
@@ -82,6 +82,7 @@ public void testCheck()
             "91: " + getCheckMessage(MSG_KEY),
             "92: " + getCheckMessage(MSG_KEY),
             "93: " + getCheckMessage(MSG_KEY),
+            "120: " + getCheckMessage(MSG_KEY),
         };
         verify(checkConfig, getPath("InputNonEmptyAtclauseDescription.java"), expected);
     }

diff --git a/...eckstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java b/...eckstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java
@@ -96,4 +96,31 @@ public int foo4(String a, int b, double c) throws Exception
 	{
 		return 1;
 	}
+
+	/**
+	 * Some javadoc
+	 * @param a Some javadoc
+	 * @param b Some javadoc
+	 * @param c Some javadoc
+	 * @return Some javadoc
+	 * @exception Exception Some javadoc
+	 * @deprecated Some javadoc
+	 */
+	public int foo5(String a, int b, double c) throws Exception
+	{
+		return 1;
+	}
+
+	/**
+	 *
+	 * @param a Some javadoc
+	 * @param b Some javadoc
+	 * @param c Some javadoc
+	 * @return Some javadoc
+	 * @exception Exception
+	 */
+	public int foo6(String a, int b, double c) throws Exception
+	{
+		return 1;
+	}
 }
diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
@@ -1463,12 +1463,14 @@ public boolean isSomething()
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#PARAM_LITERAL">PARAM_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#RETURN_LITERAL">RETURN_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#THROWS_LITERAL">THROWS_LITERAL</a>,
+              <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#TEXCEPTION_LITERAL">EXCEPTION_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#DEPRECATED_LITERAL">DEPRECATED_LITERAL</a>.
             </td>
             <td>
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#PARAM_LITERAL">PARAM_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#RETURN_LITERAL">RETURN_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#THROWS_LITERAL">THROWS_LITERAL</a>,
+              <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#TEXCEPTION_LITERAL">EXCEPTION_LITERAL</a>,
               <a href="apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#DEPRECATED_LITERAL">DEPRECATED_LITERAL</a>.
             </td>
             <td>7.3</td>