aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMichal Kordas <kordas.michal@gmail.com>2015-10-31 16:17:24 +0100
committerRoman Ivanov <ivanov-jr@mail.ru>2015-10-31 15:12:07 -0700
commit16493bfb502b73de0c19ca19d99f33bc3d6ce7e4 (patch)
treeaa213cb37a362e6df34690fe88c8169543175d24 /src
parent30881d85243468dbef8f14b81a878bc112c034a4 (diff)
downloadcheckstyle-16493bfb502b73de0c19ca19d99f33bc3d6ce7e4.tar.gz
Issue #2387: Do not recognize '/**/' as valid Javadoc
Diffstat (limited to 'src')
-rw-r--r--src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java3
-rw-r--r--src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java8
-rw-r--r--src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java8
-rw-r--r--src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputNoJavadoc.java3
4 files changed, 19 insertions, 3 deletions
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java
index 729350403..307a150ea 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java
@@ -150,7 +150,8 @@ public final class FileContents implements CommentListener {
}
// Remember if possible Javadoc comment
- if (line(startLineNo - 1).indexOf("/**", startColNo) != -1) {
+ final String firstLine = line(startLineNo - 1);
+ if (firstLine.contains("/**") && !firstLine.contains("/**/")) {
javadocComments.put(endLineNo - 1, comment);
}
}
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java
index b255ad86b..23c7f4d74 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java
@@ -333,7 +333,9 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
"105:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"106:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"107:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
- "108:9: " + getCheckMessage(MSG_JAVADOC_MISSING), };
+ "108:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
+ "119:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
+ };
verify(checkConfig, getPath("InputNoJavadoc.java"), expected);
}
@@ -376,7 +378,9 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
"96:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"105:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"107:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
- "108:9: " + getCheckMessage(MSG_JAVADOC_MISSING), };
+ "108:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
+ "119:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
+ };
verify(checkConfig, getPath("InputNoJavadoc.java"), expected);
}
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
index 58a4c4254..d277d46c3 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
@@ -206,6 +206,14 @@ public class JavadocStyleCheckTest
}
@Test
+ public void testOnInputWithNoJavadoc() throws Exception {
+ final DefaultConfiguration checkConfig = createCheckConfig(JavadocStyleCheck.class);
+ final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
+
+ verify(checkConfig, getPath("InputNoJavadoc.java"), expected);
+ }
+
+ @Test
public void testScopePublic()
throws Exception {
final DefaultConfiguration checkConfig =
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputNoJavadoc.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputNoJavadoc.java
index 5837df6ab..69f7fe550 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputNoJavadoc.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputNoJavadoc.java
@@ -114,4 +114,7 @@ class PackageClass {
// no warning, 'serialVersionUID' fields do not require Javadoc
private static final long serialVersionUID = 0;
}
+
+ /**/
+ void methodWithTwoStarComment() {}
}