Tweaks

Author: mernst

lib/src/main/java/com/diffplug/spotless/java/FormatAnnotationsStep.java

@@ -393,7 +393,6 @@ public static FormatterStep create(List<String> addedTypeAnnotations, List<Strin
 
 	private FormatAnnotationsStep() {}
 
-	// TODO: Enable users to specify more type annotations in `formatAnnotations` in build.gradle.
 	// TODO: Read from a local .type-annotations file.
 	private static final class State implements Serializable {
 		private static final long serialVersionUID = 1L;
@@ -415,13 +414,17 @@ private static final class State implements Serializable {
 		// Don't move an annotation to the start of a comment line.
 		private static final Pattern startsWithCommentPattern = Pattern.compile("^[ \t]*(//|/\\*$|/\\*|void\\b)");
 
+                /**
+                 * @param addedTypeAnnotations simple names to add to Spotless's default list
+                 * @param removedTypeAnnotations simple names to remove from Spotless's default list
+                 */
 		State(List<String> addedTypeAnnotations, List<String> removedTypeAnnotations) {
 			typeAnnotations.addAll(addedTypeAnnotations);
 			typeAnnotations.removeAll(removedTypeAnnotations);
 		}
 
 		FormatterFunc toFormatter() {
-			return unixStr -> fixupFormatAnnotations(unixStr);
+			return unixStr -> fixupTypeAnnotations(unixStr);
 		}
 
 		/**
@@ -430,7 +433,7 @@ FormatterFunc toFormatter() {
 		 * @param the text of a Java file
 		 * @return corrected text of the Java file
 		 */
-		String fixupFormatAnnotations(String unixStr) {
+		String fixupTypeAnnotations(String unixStr) {
 			// Each element of `lines` ends with a newline.
 			String[] lines = unixStr.split("((?<=\n))");
 			for (int i = 0; i < lines.length - 1; i++) {

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java

@@ -240,7 +240,9 @@ public FormatAnnotationsConfig formatAnnotations() {
 	}
 
 	public class FormatAnnotationsConfig {
+                /** Annotations in addition to those in the default list. */
 		final List<String> addedTypeAnnotations = new ArrayList<>();
+                /** Annotations that the user doesn't want treated as type annotations. */
 		final List<String> removedTypeAnnotations = new ArrayList<>();
 
 		FormatAnnotationsConfig() {

plugin-maven/README.md

@@ -290,6 +290,7 @@ A type annotation is an annotation that is meta-annotated with `@Target({Element
 Because Spotless cannot necessarily examine the annotation definition, it uses a hard-coded
 list of well-known type annotations.  You can make a pull request to add new ones.
 In the future there will be mechanisms to add/remove annotations from the list.
+These mechanisms already exist for the Gradle plugin.
 
 
 ## Groovy

plugin-maven/src/main/java/com/diffplug/spotless/maven/java/FormatAnnotations.java

@@ -26,7 +26,7 @@ public class FormatAnnotations implements FormatterStepFactory {
 
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
-		// TODO: Permit customization in Maven.
+		// TODO: Permit customization in Maven build files.
 		return FormatAnnotationsStep.create(Collections.emptyList(), Collections.emptyList());
 	}
 }

testlib/src/main/resources/java/formatannotations/FormatAnnotationsInCommentsInput.test

@@ -1,10 +1,10 @@
 class FormatAnnotationsInComments {
 
-  // Here is a comment relating to the annotation @Nullable
+  // Here is a comment
   @Interned
   String m1() {}
 
-  // Here is another comment relating to the annotation @Nullable
+  // Here is another comment
   String m2() {}
 
   /**

testlib/src/main/resources/java/formatannotations/FormatAnnotationsInCommentsOutput.test

@@ -1,9 +1,9 @@
 class FormatAnnotationsInComments {
 
-  // Here is a comment relating to the annotation @Nullable
+  // Here is a comment
   @Interned String m1() {}
 
-  // Here is another comment relating to the annotation @Nullable
+  // Here is another comment
   String m2() {}
 
   /**