Follow Oracle javadoc guidelines

maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/IntegrationTestMojo.java

@@ -135,7 +135,7 @@ public class IntegrationTestMojo extends AbstractSurefireMojo {
      * "true".
      *
      * @since 2.12
-     * @deprecated Since 3.0.0-M8, use "failsafe.failIfNoSpecifiedTests" instead.
+     * @deprecated since 3.0.0-M8, use "failsafe.failIfNoSpecifiedTests" instead
      */
     @Deprecated
     @Parameter(property = "it.failIfNoSpecifiedTests", defaultValue = "true")
@@ -667,7 +667,7 @@ public void setTestClassesDirectory(File testClassesDirectory) {
     }
 
     /**
-     * @return Output directory, or artifact file if artifact type is "jar". If not forking the JVM, parameter
+     * @return output directory, or artifact file if artifact type is "jar". If not forking the JVM, parameter
      * {@link #useSystemClassLoader} is ignored and the {@link org.apache.maven.surefire.booter.IsolatedClassLoader} is
      * used instead. See the resolution of {@link #getClassLoaderConfiguration() ClassLoaderConfiguration}.
      */

maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/VerifyMojo.java

@@ -75,7 +75,7 @@ public class VerifyMojo extends AbstractMojo implements SurefireReportParameters
      * This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec.
      *
      * @since 2.3
-     * @deprecated Use -DskipTests instead.
+     * @deprecated use -DskipTests instead
      */
     @Deprecated
     @Parameter(property = "maven.test.skip.exec")
@@ -124,6 +124,7 @@ public class VerifyMojo extends AbstractMojo implements SurefireReportParameters
 
     /**
      * Additional summary files to read integration test results from.
+     *
      * @since 2.6
      */
     @Parameter

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java

@@ -203,7 +203,7 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
      * This old parameter is just like {@code skipTests}, but bound to the old property "maven.test.skip.exec".
      *
      * @since 2.3
-     * @deprecated Use skipTests instead.
+     * @deprecated use skipTests instead
      */
     @Deprecated
     @Parameter(property = "maven.test.skip.exec")
@@ -249,6 +249,7 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
      * The matching algorithm is described in detail in <a href="https://maven.apache.org/plugins/maven-assembly-plugin/advanced-descriptor-topics.html#advanced-artifact-matching-in-includes-and-excludes">Advanced Artifact-Matching</a> for the maven-assembly-plugin. This parameter behaves the same as the {@code excludes} pattern described there.
      * The dependency matching is applied to the project dependency IDs (including transitive ones) <i>after resolving</i>, i.e. excluding
      * one dependency will not exclude its transitive dependencies!
+     *
      * @since 2.6
      */
     @Parameter(property = "maven.test.dependency.excludes")
@@ -313,8 +314,8 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
     /**
      * List of System properties to pass to a provider.
      *
-     * @deprecated Use {@link #systemPropertyVariables} instead.
      * @see #systemPropertyVariables {@code systemPropertyVariables} for how the effective provider properties are calculated
+     * @deprecated use {@link #systemPropertyVariables} instead
      */
     @Deprecated
     @Parameter
@@ -342,8 +343,8 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
      * <li>{@code line.separator}</li>
      * </ul>
      *
-     * @since 2.5
      * @see #systemProperties
+     * @since 2.5
      */
     @Parameter
     Map<String, String> systemPropertyVariables;
@@ -352,8 +353,8 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
      * If set to {@code true} will also pass all user properties exposed via {@link MavenSession#getUserProperties()} as system properties to a provider.
      * Those always take precedence over same named system properties set via any other means.
      *
-     * @since 3.4.0
      * @see #systemPropertyVariables
+     * @since 3.4.0
      */
     @Parameter(defaultValue = "true")
     boolean promoteUserPropertiesToSystemProperties;
@@ -376,6 +377,7 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
      *         {@literal <value>methods</value>}
      *     {@literal </property>}
      * {@literal </properties>}</code></pre>
+     *
      * @since 2.4
      */
     @Parameter
@@ -705,8 +707,9 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
     /**
      * Flag to disable the generation of report files in xml format.
      * Deprecated since 3.0.0-M4.
-     * @deprecated Instead use <em>disable</em> within {@code statelessTestsetReporter} since of 3.0.0-M6.
+     *
      * @since 2.2
+     * @deprecated instead use <em>disable</em> within {@code statelessTestsetReporter} since of 3.0.0-M6
      */
     @Deprecated // todo make readonly to handle system property
     @Parameter(property = "disableXmlReport")
@@ -763,6 +766,7 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
 
     /**
      * Read-only parameter with value of Maven property <i>project.build.directory</i>.
+     *
      * @since 2.20
      */
     @Parameter(defaultValue = "${project.build.directory}", readonly = true, required = true)
@@ -835,9 +839,6 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
     @Parameter
     private Map<String, String> jdkToolchain;
 
-    /**
-     *
-     */
     @Component
     private ToolchainManager toolchainManager;
 
@@ -874,7 +875,7 @@ public abstract class AbstractSurefireMojo extends AbstractMojo implements Suref
     protected abstract List<File> suiteXmlFiles();
 
     /**
-     * @return {@code true} if {@link #getSuiteXmlFiles() suite-xml files array} is not empty.
+     * @return {@code true} if {@link #getSuiteXmlFiles() suite-xml files array} is not empty
      */
     protected abstract boolean hasSuiteXmlFiles();
 
@@ -1926,6 +1927,7 @@ private static Classpath createInProcClasspath(Classpath providerClasspath, Set<
 
     /**
      * For testing purposes - Mockito.
+     *
      * @return plexus component
      */
     private LocationManager getLocationManager() {
@@ -2140,6 +2142,7 @@ private List<String> getExcludeList() throws MojoFailureException {
     /**
      * Computes a merge list of test exclusions.
      * Used only in {@link #getExcludeList()} and {@link #getExcludedScanList()}.
+     *
      * @param asScanList true if dependency or directory scanner
      * @return list of patterns
      * @throws MojoFailureException if the excludes breaks a pattern format
@@ -2182,6 +2185,7 @@ private List<String> getIncludeList() throws MojoFailureException {
     /**
      * Computes a merge list of test inclusions.
      * Used only in {@link #getIncludeList()} and {@link #getIncludedScanList()}.
+     *
      * @param asScanList true if dependency or directory scanner
      * @return list of patterns
      * @throws MojoFailureException if the includes breaks a pattern format
@@ -2544,9 +2548,9 @@ private JdkAttributes getEffectiveJvm() throws MojoFailureException {
     }
 
     /**
-     * Where surefire stores its own temp files
+     * Where surefire stores its own temp files.
      *
-     * @return A file pointing to the location of surefire's own temp files
+     * @return a file pointing to the location of surefire's own temp files
      */
     File getSurefireTempDir() {
         File result = IS_OS_WINDOWS ? createSurefireBootDirectoryInTemp() : createSurefireBootDirectoryInBuild();
@@ -2565,7 +2569,7 @@ File getSurefireTempDir() {
     /**
      * Operates on raw plugin parameters, not the "effective" values.
      *
-     * @return The checksum
+     * @return the checksum
      */
     private String getConfigChecksum() {
         ChecksumCalculator checksum = new ChecksumCalculator();
@@ -2754,9 +2758,9 @@ protected Collection<Artifact> resolveDependencies(List<Dependency> dependencies
     /**
      * Return a new set containing only the artifacts not accepted by the given filter.
      *
-     * @param artifacts The unfiltered artifacts
-     * @param filter    The excludes filter to apply
-     * @return The filtered result
+     * @param artifacts the unfiltered artifacts
+     * @param filter    the excludes filter to apply
+     * @return the filtered result
      */
     private static Set<Artifact> filterArtifacts(Set<Artifact> artifacts, ArtifactFilter filter) {
         Set<Artifact> filteredArtifacts = new LinkedHashSet<>();

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireExecutionParameters.java

@@ -22,7 +22,7 @@
 import java.util.List;
 
 /**
- * This interface contains all the common parameters that have different implementations in Surefire vs IntegrationTest
+ * This interface contains all the common parameters that have different implementations in Surefire vs IntegrationTest.
  *
  * @author Stephen Connolly
  */

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireHelper.java

@@ -49,7 +49,7 @@
 import static org.apache.maven.surefire.shared.lang3.SystemUtils.IS_OS_WINDOWS;
 
 /**
- * Helper class for surefire plugins
+ * Helper class for surefire plugins.
  */
 public final class SurefireHelper {
     private static final String DUMP_FILE_DATE = newFormattedDateFileName();
@@ -95,7 +95,7 @@ public final class SurefireHelper {
 
     /**
      * The placeholder that is replaced by the executing fork's running number. The fork number
-     * range starts with 1
+     * range starts with 1.
      */
     private static final String FORK_NUMBER_PLACEHOLDER = "${surefire.forkNumber}";
 

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireProperties.java

@@ -102,7 +102,8 @@ public synchronized Enumeration<Object> keys() {
     }
 
     /**
-     * Copies all keys and values from source to these properties, overwriting existing properties with same name
+     * Copies all keys and values from source to these properties, overwriting existing properties with same name.
+     *
      * @param source
      * @return all overwritten property names (may be empty if there was no property name clash)
      */
@@ -115,7 +116,8 @@ public Collection<String> copyPropertiesFrom(Properties source) {
     }
 
     /**
-     * Copies all keys and values from source to these properties, overwriting existing properties with same name
+     * Copies all keys and values from source to these properties, overwriting existing properties with same name.
+     *
      * @param source
      * @return all overwritten property names (may be empty if there was no property name clash)
      */

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/BooterSerializer.java

@@ -97,7 +97,7 @@ class BooterSerializer {
     }
 
     /**
-     * Does not modify sourceProperties
+     * Does not modify sourceProperties.
      */
     File serialize(
             KeyValueSource sourceProperties,

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java

@@ -139,7 +139,7 @@ public final ForkNodeFactory getForkNodeFactory() {
     }
 
     /**
-     * @param config       The startup configuration
+     * @param config       the startup configuration
      * @param forkNumber   index of forked JVM, to be the replacement in the argLine
      * @param dumpLogDirectory     directory for dump log file
      * @return CommandLine able to flush entire command going to be sent to forked JVM

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java

@@ -79,7 +79,7 @@ public abstract class ForkConfiguration {
     protected abstract Classpath getBooterClasspath();
 
     /**
-     * @param config               The startup configuration
+     * @param config               the startup configuration
      * @param forkNumber           index of forked JVM, to be the replacement in the argLine
      * @param dumpLogDirectory     directory for dump log file
      * @return CommandLine able to flush entire command going to be sent to forked JVM

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkNumberBucket.java

@@ -36,7 +36,7 @@ public final class ForkNumberBucket {
     private final AtomicInteger highWaterMark = new AtomicInteger(1);
 
     /**
-     * Non-public constructor
+     * Non-public constructor.
      */
     private ForkNumberBucket() {}
 
@@ -49,7 +49,7 @@ public static int drawNumber() {
     }
 
     /**
-     * @param number the number to return to the bucket so that it can be reused.
+     * @param number the number to return to the bucket so that it can be reused
      */
     public static void returnNumber(int number) {
         getInstance().returnNumberInternal(number);
@@ -79,7 +79,7 @@ private int getHighestDrawnNumber() {
     }
 
     /**
-     * @param number the number to return to the bucket so that it can be reused.
+     * @param number the number to return to the bucket so that it can be reused
      */
     private void returnNumberInternal(int number) {
         qFree.add(number);

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkStarter.java

@@ -112,7 +112,7 @@
  * <br>
  * Lives only on the plugin-side (not present in remote vms)
  * <br>
- * Knows how to fork new vms and also how to delegate non-forking invocation to SurefireStarter directly
+ * Knows how to fork new vms and also how to delegate non-forking invocation to SurefireStarter directly.
  *
  * @author Jason van Zyl
  * @author Emmanuel Venisse

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java

@@ -116,10 +116,10 @@ protected void resolveClasspath(
      * Create a jar with just a manifest containing a Main-Class entry for BooterConfiguration and a Class-Path entry
      * for all classpath elements.
      *
-     * @param classPath      List<String> of all classpath elements.
-     * @param startClassName The class name to start (main-class)
+     * @param classPath      List<String> of all classpath elements
+     * @param startClassName the class name to start (main-class)
      * @return file of the jar
-     * @throws IOException When a file operation fails.
+     * @throws IOException when a file operation fails
      */
     @Nonnull
     private File createJar(

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/Commandline.java

@@ -38,7 +38,7 @@ public class Commandline extends org.apache.maven.surefire.shared.utils.cli.Comm
     private final Set<String> addedEnvironmentVariables;
 
     /**
-     * for testing purposes only
+     * For testing purposes only.
      */
     public Commandline() {
         this(new String[0]);

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/DefaultCommandReader.java

@@ -26,12 +26,13 @@
  * Reader stream sends commands to forked jvm std-{@link java.io.InputStream input-stream}.
  *
  * @author <a href="mailto:[email protected]">Tibor Digana (tibor17)</a>
- * @since 2.19
  * @see Command
+ * @since 2.19
  */
 public abstract class DefaultCommandReader extends AbstractCommandReader {
     /**
      * Opposite to {@link #isClosed()}.
+     *
      * @return {@code true} if not closed
      */
     protected boolean canContinue() {

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/NotifiableTestStream.java

@@ -29,9 +29,9 @@
  * throw {@link UnsupportedOperationException}.
  *
  * @author <a href="mailto:[email protected]">Tibor Digana (tibor17)</a>
- * @since 2.19
  * @see TestProvidingInputStream
  * @see TestLessInputStream
+ * @since 2.19
  */
 public interface NotifiableTestStream {
     /**

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestLessInputStream.java

@@ -203,7 +203,7 @@ public NotifiableTestStream getImmediateCommands() {
          * {@link NotifiableTestStream#skipSinceNextTest()} are supported.
          * Another methods throw {@link UnsupportedOperationException}.
          *
-         * @return commands which are cached for currently alive or future forks.
+         * @return commands which are cached for currently alive or future forks
          */
         public NotifiableTestStream getCachableCommands() {
             return cachableCommands;

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestProvidingInputStream.java

@@ -55,7 +55,7 @@ public final class TestProvidingInputStream extends DefaultCommandReader {
     private final Queue<String> testClassNames;
 
     /**
-     * C'tor
+     * C'tor.
      *
      * @param testClassNames source of the tests to be read from this stream
      */

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/DeserializedStacktraceWriter.java

@@ -25,7 +25,7 @@
  * Represents a deserialize stacktracewriter that has been
  * marshalled across to the plugin from the fork.
  * <br>
- * Might be better to represent this whole thing differently
+ * Might be better to represent this whole thing differently.
  *
  * @author Kristian Rosenvold
  */

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java

@@ -349,7 +349,7 @@ public Map<String, String> getTestVmSystemProperties() {
      * Used when getting reporters on the plugin side of a fork.
      * Used by testing purposes only. May not be volatile variable.
      *
-     * @return A mock provider reporter
+     * @return a mock provider reporter
      */
     public RunListener getReporter() {
         return getTestSetReporter();

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java

@@ -53,7 +53,7 @@
 import static org.apache.maven.surefire.api.booter.ForkedProcessEventType.BOOTERCODE_TEST_SUCCEEDED;
 
 /**
- * magic number : run mode : opcode [: opcode specific data]*
+ * Magic number : run mode : opcode [: opcode specific data]*
  *
  * @author <a href="mailto:[email protected]">Tibor Digana (tibor17)</a>
  * @since 3.0.0-M4

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java

@@ -22,8 +22,8 @@
 
 /**
  * @author <a href="mailto:[email protected]">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
  * @param <T> report entry type
+ * @since 3.0.0-M4
  */
 public interface ForkedProcessReportEventListener<T extends ReportEntry> {
     void handle(T reportEntry);