aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLev_Sikhovets <lev.sikhovets@gmail.com>2017-12-27 15:27:29 +0300
committerRoman Ivanov <romani@users.noreply.github.com>2017-12-27 08:57:09 -0800
commitd5c3d379ad0d6e0a1511162075981806d2ab2d8f (patch)
treee0be6e5104b8ecff74dde66092ad708e9466dda4
parent1c73987f2f560ecabb6825943c8362fb11b67749 (diff)
downloadcheckstyle-d5c3d379ad0d6e0a1511162075981806d2ab2d8f.tar.gz
Issue #5388: added exception JavaDoc block tag to NonEmptyAtclauseDescriptionCheck
-rw-r--r--src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java1
-rw-r--r--src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java1
-rw-r--r--src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java27
-rw-r--r--src/xdocs/config_javadoc.xml2
4 files changed, 31 insertions, 0 deletions
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java
index 77516206b..73e46a097 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheck.java
@@ -48,6 +48,7 @@ public class NonEmptyAtclauseDescriptionCheck extends AbstractJavadocCheck {
JavadocTokenTypes.PARAM_LITERAL,
JavadocTokenTypes.RETURN_LITERAL,
JavadocTokenTypes.THROWS_LITERAL,
+ JavadocTokenTypes.EXCEPTION_LITERAL,
JavadocTokenTypes.DEPRECATED_LITERAL,
};
}
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java
index 3bf65b75c..df90f72ca 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/NonEmptyAtclauseDescriptionCheckTest.java
@@ -82,6 +82,7 @@ public class NonEmptyAtclauseDescriptionCheckTest
"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/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java
index bf3346d00..1251e9955 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription/InputNonEmptyAtclauseDescription.java
@@ -96,4 +96,31 @@ class InputNonEmptyAtclauseDescription
{
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
index 5b8e43627..49da8de24 100644
--- 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>