Merge pull request #199 from maverick2012

* pr/199:
  Polish 'Add checkstyle rule for method javadoc empty lines'
  Add checkstyle rule for method javadoc empty lines

Closes gh-17005

Author: philwebb

spring-javaformat/spring-javaformat-checkstyle/src/main/java/io/spring/javaformat/checkstyle/check/SpringJavadocCheck.java

@@ -53,6 +53,8 @@ public class SpringJavadocCheck extends AbstractSpringCheck {
 
 	private static final Pattern SINCE_TAG_PATTERN = Pattern.compile("@since\\s+(.*)");
 
+	private static final Pattern AT_TAG_PATTERN = Pattern.compile("@\\w+\\s+.*");
+
 	private static final Set<Integer> TOP_LEVEL_TYPES;
 	static {
 		Set<Integer> topLevelTypes = new HashSet<Integer>();
@@ -93,6 +95,7 @@ private void checkJavadoc(DetailAST ast, TextBlock javadoc) {
 		checkBannedTags(ast, javadoc);
 		checkTagCase(ast, javadoc);
 		checkSinceTag(ast, javadoc);
+		checkMethodJavaDoc(ast, javadoc);
 	}
 
 	private void checkBannedTags(DetailAST ast, TextBlock javadoc) {
@@ -147,6 +150,19 @@ private void checkSinceTag(DetailAST ast, TextBlock javadoc) {
 		}
 	}
 
+	private void checkMethodJavaDoc(DetailAST ast, TextBlock javadoc) {
+		if (TokenTypes.METHOD_DEF != ast.getType()) {
+			return;
+		}
+		String[] text = javadoc.getText();
+		for (int i = 0; i < text.length; i++) {
+			Matcher matcher = AT_TAG_PATTERN.matcher(text[i]);
+			if (matcher.find() && i > 0 && text[i - 1].trim().equals("*")) {
+				log(javadoc.getStartLineNo() + i - 1, 0, "javadoc.emptyLineBeforeTag");
+			}
+		}
+	}
+
 	private boolean startsWithUppercase(String description) {
 		return description.length() > 0 && Character.isUpperCase(description.charAt(0));
 	}

spring-javaformat/spring-javaformat-checkstyle/src/main/resources/io/spring/javaformat/checkstyle/check/messages.properties

@@ -9,6 +9,7 @@ javadoc.badCase=Javadoc element descriptions should not start with an uppercase
 javadoc.bannedTag=Javadoc tag ''{0}'' should not be used.
 javadoc.missingSince=Missing Javadoc @since tag.
 javadoc.publicSince=Javadoc @since tag should not be used on private classes.
+javadoc.emptyLineBeforeTag=Method Javadoc should not have empty line before tag.
 junit5.bannedImport=Import ''{0}'' should not be used in a JUnit 5 test.
 junit5.bannedTestAnnotation=JUnit 4 @Test annotation should not be used in a JUnit 5 test.
 junit5.lifecyclePrivateMethod=Lifecycle method ''{0}'' should not be private.

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/check/JavadocMethodEmptyLineBeforeTag.txt

@@ -0,0 +1,2 @@
++Method Javadoc should not have empty line before tag.
++1 error

spring-javaformat/spring-javaformat-checkstyle/src/test/resources/source/JavadocMethodEmptyLineBeforeTag.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2017-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Javadoc with white space.
+ * @param <T> this is a valid param
+ * @author Sushant Kumar Singh
+ */
+public class JavadocMethodEmptyLineBeforeTag<T> {
+
+	/**
+	 * Do something.
+	 *
+	 * @param something a lovely thing
+	 */
+	public void test(String something) {
+	}
+
+}