Fix javadoc.

diffplug · Jan 26, 2023 · 9adce64 · 9adce64
1 parent 07a57ff
commit 9adce64
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/lib/src/main/java/com/diffplug/spotless/Formatter.java b/lib/src/main/java/com/diffplug/spotless/Formatter.java
@@ -290,6 +290,6 @@ public void close() {
 		}
 	}
 
-	/** This Sentinel reference may be used to  Formatter requires a File, while there is no actual File to format */
+	/** This Sentinel reference may be used to pass string content to a Formatter or FormatterStep when there is no actual File to format */
 	public static final File NO_FILE_SENTINEL = new File("NO_FILE_SENTINEL");
 }
diff --git a/lib/src/main/java/com/diffplug/spotless/FormatterStep.java b/lib/src/main/java/com/diffplug/spotless/FormatterStep.java
@@ -38,7 +38,7 @@ public interface FormatterStep extends Serializable {
 	 *            the content to format, guaranteed to have unix-style newlines ('\n'); never null
 	 * @param file
 	 *            the file which {@code rawUnix} was obtained from; never null. Pass the reference
-	 *            {@code FormatterStepImpl#SENTINEL} if and only if no file is actually associated with {@code rawUnix}
+	 *            {@link Formatter#NO_FILE_SENTINEL} if and only if no file is actually associated with {@code rawUnix}
 	 * @return the formatted content, guaranteed to only have unix-style newlines; may return null
 	 *         if the formatter step doesn't have any changes to make
 	 * @throws Exception if the formatter step experiences a problem