Add <p> tags to Javadoc comments (#1863)

Author: nedtwigg

lib-extra/src/main/java/com/diffplug/spotless/extra/GitAttributesLineEndings.java

@@ -246,7 +246,7 @@ static class Runtime {
 
 		/**
 		 * Default line ending, determined in this order (paths are a teensy different platform to platform).
-		 *
+		 * <p>
 		 * - .git/config (per-repo)
 		 * - ~/.gitconfig (per-user)
 		 * - /etc/gitconfig (system-wide)

lib-extra/src/main/java/com/diffplug/spotless/extra/GitWorkarounds.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2022 DiffPlug
+ * Copyright 2020-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ private GitWorkarounds() {}
 
 	/**
 	 * Finds the .git directory for the given project directory.
-	 *
+	 * <p>
 	 * Ordinarily one would just use JGit for this, but it doesn't support worktrees properly.
 	 * So this applies an additional workaround for that.
 	 *
@@ -55,7 +55,7 @@ private GitWorkarounds() {}
 
 	/**
 	 * Creates a {@link RepositorySpecificResolver} for the given project directory.
-	 *
+	 * <p>
 	 * This applies a workaround for JGit not supporting worktrees properly.
 	 *
 	 * @param projectDir the project directory.
@@ -67,7 +67,7 @@ static RepositorySpecificResolver fileRepositoryResolverForProject(File projectD
 
 	/**
 	 * Creates a {@link RepositorySpecificResolver} for the given project directory.
-	 *
+	 * <p>
 	 * This applies a workaround for JGit not supporting worktrees properly.
 	 *
 	 * @param projectDir the project directory.
@@ -86,7 +86,7 @@ static RepositorySpecificResolver fileRepositoryResolverForProject(File projectD
 
 	/**
 	 * Piggyback on the {@link FileRepositoryBuilder} mechanics for finding the git directory.
-	 *
+	 * <p>
 	 * Here we take into account that git repositories can share a common directory. This directory
 	 * will contain ./config ./objects/, ./info/, and ./refs/.
 	 */

lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseCdtFormatterStep.java

@@ -27,7 +27,7 @@
 
 /**
  * Formatter step which calls out to the Eclipse CDT formatter.
- *
+ * <p>
  * Eclipse-CDT <code>org.eclipse.core.contenttype.contentTypes</code>
  * extension <code>cSource</code>, <code>cHeader</code>, <code>cxxSource</code> and <code>cxxHeader</code>.
  * can handle: "c", "h", "C", "cpp", "cxx", "cc", "c++", "h", "hpp", "hh", "hxx", "inc"

lib-extra/src/main/java/com/diffplug/spotless/extra/integration/DiffMessageFormatter.java

@@ -249,9 +249,9 @@ private String diff(File file) throws IOException {
 
 	/**
 	 * Returns a git-style diff between the two unix strings.
-	 *
+	 * <p>
 	 * Output has no trailing newlines.
-	 *
+	 * <p>
 	 * Boolean args determine whether whitespace or line endings will be visible.
 	 */
 	private static String diffWhitespaceLineEndings(String dirty, String clean, boolean whitespace, boolean lineEndings) throws IOException {
@@ -278,7 +278,7 @@ private static String diffWhitespaceLineEndings(String dirty, String clean, bool
 
 	/**
 	 * Makes the whitespace and/or the lineEndings visible.
-	 *
+	 * <p>
 	 * MyersDiff wants inputs with only unix line endings.  So this ensures that that is the case.
 	 */
 	private static String visibleWhitespaceLineEndings(String input, boolean whitespace, boolean lineEndings) {

lib-extra/src/test/java/com/diffplug/spotless/extra/groovy/GrEclipseFormatterStepSpecialCaseTest.java

@@ -24,7 +24,7 @@
 public class GrEclipseFormatterStepSpecialCaseTest {
 	/**
 	 * https://github.com/diffplug/spotless/issues/1657
-	 *
+	 * <p>
 	 * broken: ${parm == null ? "" : "<tag>$parm</tag>"}
 	 *  works: ${parm == null ? "" : "<tag>parm</tag>"}
 	 */

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

@@ -34,7 +34,7 @@
  * but linked against the `Url[]`. This allows us to ship classfiles which function as glue
  * code but delay linking/definition to runtime after the user has specified which version
  * of the formatter they want.
- *
+ * <p>
  *  For `"org.slf4j.` and (`com.diffplug.spotless.` but not `com.diffplug.spotless.extra.`)
  * 	the classes are loaded from the buildToolClassLoader.
  */

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 DiffPlug
+ * Copyright 2020-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@
  * Finds a foreign executable and checks its version.
  * If either part of that fails, it shows you why
  * and helps you fix it.
- *
+ * <p>
  * Usage: {@code ForeignExe.nameAndVersion("grep", "2.5.7").confirmVersionAndGetAbsolutePath()}
  * will find grep, confirm that it is version 2.5.7, and then return.
  */

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ public interface FormatExceptionPolicy extends Serializable, NoLambda {
 
 	/**
 	 * Returns a byte array representation of everything inside this {@code FormatExceptionPolicy}.
-	 *
+	 * <p>
 	 * The main purpose of this method is to ensure one can't instantiate this class with lambda
 	 * expressions, which are notoriously difficult to serialize and deserialize properly.
 	 */

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

@@ -193,7 +193,7 @@ public void applyTo(File file) throws IOException {
 
 	/**
 	 * Applies formatting to the given file.
-	 *
+	 * <p>
 	 * Returns null if the file was already clean, or the
 	 * formatted result with unix newlines if it was not.
 	 */

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

@@ -42,11 +42,11 @@ interface Closeable extends FormatterFunc, AutoCloseable {
 
 		/**
 		 * Dangerous way to create a {@link Closeable} from an AutoCloseable and a function.
-		 *
+		 * <p>
 		 * It's important for FormatterStep's to allocate their resources as lazily as possible.
 		 * It's easy to create a resource inside the state, and not realize that it may not be
 		 * released.  It's far better to use one of the non-deprecated {@code of()} methods below.
-		 *
+		 * <p>
 		 * The bug (and its fix) which is easy to write using this method: https://github.com/diffplug/spotless/commit/7f16ecca031810b5e6e6f647e1f10a6d2152d9f4
 		 * How the {@code of()} methods below make the correct thing easier to write and safer: https://github.com/diffplug/spotless/commit/18c10f9c93d6f18f753233d0b5f028d5f0961916
 		 */