Follow Oracle javadoc guidelines
diff --git a/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/IntegrationTestMojo.java b/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/IntegrationTestMojo.java
index a15301e..f6a881d 100644
--- a/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/IntegrationTestMojo.java
+++ b/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}.
*/
diff --git a/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/VerifyMojo.java b/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/VerifyMojo.java
index e53f407..1d499e6 100644
--- a/maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/VerifyMojo.java
+++ b/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
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
index f7ffb65..a6f58e9 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
+++ b/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<>();
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireExecutionParameters.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireExecutionParameters.java
index d69cb88..a8ff82e 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireExecutionParameters.java
+++ b/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
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireHelper.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireHelper.java
index 6285506..bd3e082 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireHelper.java
+++ b/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}";
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireProperties.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireProperties.java
index 6aeef18..0424ff8 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireProperties.java
+++ b/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)
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/BooterSerializer.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/BooterSerializer.java
index 2dbc27b..61b0867 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/BooterSerializer.java
+++ b/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,
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java
index d78f680..a851750 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java
+++ b/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
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java
index f5b37ed..65c719f 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java
+++ b/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
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkNumberBucket.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkNumberBucket.java
index dde5284..b3690bb 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkNumberBucket.java
+++ b/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);
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkStarter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkStarter.java
index c612861..5b85a64 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkStarter.java
+++ b/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
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java
index a13de8f..4bd12a3 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java
+++ b/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(
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/Commandline.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/Commandline.java
index 651e80c..437f92f 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/Commandline.java
+++ b/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]);
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/DefaultCommandReader.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/DefaultCommandReader.java
index 42e3391..953323d 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/DefaultCommandReader.java
+++ b/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:tibordigana@apache.org">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() {
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/NotifiableTestStream.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/NotifiableTestStream.java
index d12f3ed..56b0e79 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/NotifiableTestStream.java
+++ b/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:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.19
* @see TestProvidingInputStream
* @see TestLessInputStream
+ * @since 2.19
*/
public interface NotifiableTestStream {
/**
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestLessInputStream.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestLessInputStream.java
index 7b9aa3a..04a2c73 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestLessInputStream.java
+++ b/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;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestProvidingInputStream.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestProvidingInputStream.java
index 99b358a..3432307 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestProvidingInputStream.java
+++ b/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
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/DeserializedStacktraceWriter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/DeserializedStacktraceWriter.java
index 7ac2bb8..f67faa0 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/DeserializedStacktraceWriter.java
+++ b/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
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java
index cecc271..7ea282e 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java
+++ b/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();
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java
index a3cedd0..bccc0b9 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java
+++ b/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:tibordigana@apache.org">Tibor Digana (tibor17)</a>
* @since 3.0.0-M4
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java
index ec25a31..2714927 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java
@@ -22,8 +22,8 @@
/**
* @author <a href="mailto:tibordigana@apache.org">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);
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/NativeStdErrStreamConsumer.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/NativeStdErrStreamConsumer.java
index 9b7fd7e..11b3340 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/NativeStdErrStreamConsumer.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/NativeStdErrStreamConsumer.java
@@ -27,8 +27,8 @@
* see {@link org.apache.maven.plugin.surefire.booterclient.ForkStarter}.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.20
* @see org.apache.maven.plugin.surefire.booterclient.ForkStarter
+ * @since 2.20
*/
public final class NativeStdErrStreamConsumer implements EventHandler<String> {
private final Object errStreamLock;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ThreadedStreamConsumer.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ThreadedStreamConsumer.java
index 7e1cdc5..658b6da 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ThreadedStreamConsumer.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ThreadedStreamConsumer.java
@@ -156,9 +156,6 @@ private static boolean shouldStopQueueing(Event item) {
return item == END_ITEM;
}
- /**
- *
- */
private static class FinalEvent extends Event {
FinalEvent() {
super(null);
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
index cac48b6..6716ca5 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
@@ -34,9 +34,6 @@
import org.apache.maven.surefire.extensions.util.CountdownCloseable;
import org.apache.maven.surefire.stream.EventDecoder;
-/**
- *
- */
public class EventConsumerThread extends CloseableDaemonThread {
private final ReadableByteChannel channel;
private final EventHandler<Event> eventHandler;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/SurefireStatelessReporter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/SurefireStatelessReporter.java
index 26b4164..0f0d4ca 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/SurefireStatelessReporter.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/SurefireStatelessReporter.java
@@ -33,6 +33,7 @@
* The listener handles <em>testSetCompleted</em> event.
*
* author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
+ *
* @since 3.0.0-M4
*/
public class SurefireStatelessReporter
@@ -46,6 +47,7 @@ public SurefireStatelessReporter() {
/**
* Activated if null injection point in MOJO.
+ *
* @param disable {@code true} to disable performing the report
* @param version version of the schema
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5ConsoleOutputReporter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5ConsoleOutputReporter.java
index a5290ea..da0ff3c 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5ConsoleOutputReporter.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5ConsoleOutputReporter.java
@@ -29,6 +29,7 @@
* Selectively enables report files upon JUnit5 annotation <em>DisplayName</em>.
*
* author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
+ *
* @since 3.0.0-M4
*/
public class JUnit5ConsoleOutputReporter extends SurefireConsoleOutputReporter {
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5Xml30StatelessReporter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5Xml30StatelessReporter.java
index e6cc39d..d6719da 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5Xml30StatelessReporter.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5Xml30StatelessReporter.java
@@ -30,6 +30,7 @@
* Selectively enables phrased classes, methods and report files upon JUnit5 annotation <em>DisplayName</em>.
*
* author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
+ *
* @since 3.0.0-M4
*/
public class JUnit5Xml30StatelessReporter extends SurefireStatelessReporter {
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/log/PluginConsoleLogger.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/log/PluginConsoleLogger.java
index 15640eb..5a621b5 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/log/PluginConsoleLogger.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/log/PluginConsoleLogger.java
@@ -29,8 +29,8 @@
* {@link org.apache.maven.plugin.surefire.report.TestSetRunListener}.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.20
* @see ConsoleLogger
+ * @since 2.20
*/
public final class PluginConsoleLogger implements ConsoleLogger {
private final Logger logger;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/DefaultReporterFactory.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/DefaultReporterFactory.java
index f95c061..f8fbc70 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/DefaultReporterFactory.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/DefaultReporterFactory.java
@@ -201,7 +201,7 @@ public RunStatistics getGlobalRunStatistics() {
/**
* Get the result of a test based on all its runs. If it has success and failures/errors, then it is a flake;
- * if it only has errors or failures, then count its result based on its first run
+ * if it only has errors or failures, then count its result based on its first run.
*
* @param reportEntries the list of test run report type for a given test
* @param rerunFailingTestsCount configured rerun count for failing tests
@@ -309,7 +309,7 @@ private void mergeTestHistoryResult() {
/**
* Print failed tests and flaked tests. A test is considered as a failed test if it failed/got an error with
- * all the runs. If a test passes in ever of the reruns, it will be count as a flaked test
+ * all the runs. If a test passes in ever of the reruns, it will be count as a flaked test.
*
* @param type the type of results to be printed, could be error, failure or flake
* @return {@code true} if printed some lines
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/FileReporterUtils.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/FileReporterUtils.java
index fb54eda..3b69313 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/FileReporterUtils.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/FileReporterUtils.java
@@ -21,7 +21,7 @@
import static org.apache.maven.surefire.shared.lang3.SystemUtils.IS_OS_WINDOWS;
/**
- * Utils class for file-based reporters
+ * Utils class for file-based reporters.
*
* @author Andreas Gudian
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/ReportEntryType.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/ReportEntryType.java
index 8fb31be..4371482 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/ReportEntryType.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/ReportEntryType.java
@@ -19,8 +19,7 @@
package org.apache.maven.plugin.surefire.report;
/**
- * Type of an entry in the report
- *
+ * Type of an entry in the report.
*/
public enum ReportEntryType {
ERROR("error", "flakyError", "rerunError"),
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java
index 05b5059..69ed4ab 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java
@@ -349,14 +349,14 @@ private void serializeTestClassWithRerun(
}
/**
- * Clean testClassMethodRunHistoryMap
+ * Clean testClassMethodRunHistoryMap.
*/
public void cleanTestHistoryMap() {
testClassMethodRunHistoryMap.clear();
}
/**
- * Get the result of a test from a list of its runs in WrappedReportEntry
+ * Get the result of a test from a list of its runs in WrappedReportEntry.
*
* @param methodEntryList the list of runs for a given test
* @return the TestResultType for the given test
@@ -535,7 +535,7 @@ private static void addOutputStreamElement(
* Adds system properties to the XML report.
* <br>
*
- * @param xmlWriter The test suite to report to
+ * @param xmlWriter the test suite to report to
*/
private static void showProperties(XMLWriter xmlWriter, Map<String, String> systemProperties) throws IOException {
xmlWriter.startElement("properties");
@@ -561,8 +561,8 @@ private static void showProperties(XMLWriter xmlWriter, Map<String, String> syst
/**
* Handle stuff that may pop up in java that is not legal in xml.
*
- * @param message The string
- * @return The escaped string or returns itself if all characters are legal
+ * @param message the string
+ * @return the escaped string or returns itself if all characters are legal
*/
private static String extraEscapeAttribute(String message) {
// Someday convert to xml 1.1 which handles everything but 0 inside string
@@ -572,7 +572,7 @@ private static String extraEscapeAttribute(String message) {
/**
* Writes escaped string or the message within CDATA if all characters are legal.
*
- * @param message The string
+ * @param message the string
*/
private static void extraEscapeElementValue(
String message, OutputStreamWriter outputStreamWriter, XMLWriter xmlWriter, OutputStream fw)
@@ -665,11 +665,11 @@ private static boolean isIllegalEscape(int c) {
}
/**
- * escape for XML 1.0
+ * Escape for XML 1.0.
*
- * @param text The string
+ * @param text the string
* @param attribute true if the escaped value is inside an attribute
- * @return The escaped string
+ * @return the escaped string
*/
private static String escapeXml(String text, boolean attribute) {
StringBuilder sb = new StringBuilder(text.length() * 2);
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestMethodStats.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestMethodStats.java
index d3abb53..8357272 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestMethodStats.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestMethodStats.java
@@ -21,11 +21,9 @@
import org.apache.maven.surefire.api.report.StackTraceWriter;
/**
- *
* Maintains per-thread test result state for a single test method.
*
* @author Qingzhou Luo
- *
*/
public class TestMethodStats {
private final String testClassMethodName;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetRunListener.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetRunListener.java
index 6e79c05..3879ef5 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetRunListener.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetRunListener.java
@@ -51,7 +51,7 @@ public class TestSetRunListener implements TestReportListener<TestOutputReportEn
private final Queue<TestMethodStats> testMethodStats = new ConcurrentLinkedQueue<>();
/**
- * will be used only if report entry have a sourceName other than that #currentTestSetStats will be used
+ * Will be used only if report entry have a sourceName other than that #currentTestSetStats will be used
* it looks some provider doesn't provide enough information so we assume to use previous technique
* class field (this is definitely hackish)
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/DependencyScanner.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/DependencyScanner.java
index 156f280..460f971 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/DependencyScanner.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/DependencyScanner.java
@@ -82,7 +82,6 @@ private static void scanArtifact(File artifact, TestFilter<String, String> filte
}
/**
- *
* @param artifacts a list to filter
* @param artifactPatterns a list of strings in the form
* <pre>groupId[:artifactId[:type[:classifier][:version]]]</pre>
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/Relocator.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/Relocator.java
index 9c1438a..3524c88 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/Relocator.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/Relocator.java
@@ -21,7 +21,7 @@
import javax.annotation.Nonnull;
/**
- * Relocates class names when running with relocated provider
+ * Relocates class names when running with relocated provider.
*
* @author Kristian Rosenvold
*/
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/SpecificFileFilter.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/SpecificFileFilter.java
index 8246180..5c93374 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/SpecificFileFilter.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/SpecificFileFilter.java
@@ -28,8 +28,7 @@
import static org.apache.maven.plugin.surefire.util.ScannerUtil.convertSlashToSystemFileSeparator;
/**
- * filters file names by a given collection of class name patterns
- *
+ * Filters file names by a given collection of class name patterns.
*/
@Deprecated
public class SpecificFileFilter {
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/surefire/providerapi/ServiceLoader.java b/maven-surefire-common/src/main/java/org/apache/maven/surefire/providerapi/ServiceLoader.java
index d33500a..76cac33 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/surefire/providerapi/ServiceLoader.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/surefire/providerapi/ServiceLoader.java
@@ -78,9 +78,9 @@ public Set<String> lookup(Class<?> clazz, ClassLoader classLoader) throws IOExce
* Method loadServices loads the services of a class that are
* defined using the SPI mechanism.
*
- * @param urlEnumeration The urls from the resource
- * @return The set of service provider names
- * @throws IOException When reading the streams fails
+ * @param urlEnumeration the urls from the resource
+ * @return the set of service provider names
+ * @throws IOException when reading the streams fails
*/
@Nonnull
@SuppressWarnings("checkstyle:innerassignment")
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/CommandEncoder.java b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/CommandEncoder.java
index ef5b2a4..6cce135 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/CommandEncoder.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/CommandEncoder.java
@@ -39,9 +39,6 @@
import static org.apache.maven.surefire.api.booter.MasterProcessCommand.SKIP_SINCE_NEXT_TEST;
import static org.apache.maven.surefire.api.booter.MasterProcessCommand.TEST_SET_FINISHED;
-/**
- *
- */
public class CommandEncoder extends AbstractStreamEncoder<MasterProcessCommand> implements AutoCloseable {
private final WritableByteChannel out;
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
index 0bfc1e2..0b08f89 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
@@ -74,9 +74,6 @@
import static org.apache.maven.surefire.api.stream.SegmentType.TEST_RUN_ID;
import static org.apache.maven.surefire.shared.utils.cli.ShutdownHookUtils.addShutDownHook;
-/**
- *
- */
public class EventDecoder extends AbstractStreamDecoder<Event, ForkedProcessEventType, SegmentType> {
private static final int DEBUG_SINK_BUFFER_SIZE = 64 * 1024;
// due to have fast and thread-safe Map
diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java
index 95ca6b3..98d33b8 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java
@@ -112,7 +112,7 @@ public abstract class AbstractSurefireReport extends AbstractMavenReport {
private List<File> resolvedReportsDirectories;
/**
- * Internationalization component
+ * Internationalization component.
*/
private I18N i18n;
@@ -123,7 +123,7 @@ protected AbstractSurefireReport(I18N i18n) {
/**
* Whether the report should be generated or not.
*
- * @return {@code true} if and only if the report should be generated.
+ * @return {@code true} if and only if the report should be generated
* @since 2.11
*/
protected boolean isSkipped() {
@@ -133,7 +133,7 @@ protected boolean isSkipped() {
/**
* Whether the report should be generated when there are no test results.
*
- * @return {@code true} if and only if the report should be generated when there are no result files at all.
+ * @return {@code true} if and only if the report should be generated when there are no result files at all
* @since 2.11
*/
protected boolean isGeneratedWhenNoResults() {
@@ -239,8 +239,8 @@ private List<File> getReportsDirectories() {
/**
* Gets the default surefire reports directory for the specified project.
*
- * @param subProject the project to query.
- * @return the default surefire reports directory for the specified project.
+ * @param subProject the project to query
+ * @return the default surefire reports directory for the specified project
*/
protected abstract File getSurefireReportsDirectory(MavenProject subProject);
@@ -257,7 +257,7 @@ private List<MavenProject> getProjectsWithoutRoot() {
/**
* @param locale the locale
* @param key the key to search fo
- * @return the text appropriate for the locale.
+ * @return the text appropriate for the locale
*/
protected String getI18nString(Locale locale, String key) {
return getI18N(locale).getString("surefire-report", locale, "report." + getI18Nsection() + '.' + key);
@@ -287,13 +287,17 @@ protected I18N getI18N(Locale locale) {
*/
protected abstract String getI18Nsection();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getName(Locale locale) {
return getI18nString(locale, "name");
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDescription(Locale locale) {
return getI18nString(locale, "description");
@@ -358,73 +362,97 @@ private static class CustomI18N implements I18N {
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDefaultLanguage() {
return locale.getLanguage();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDefaultCountry() {
return locale.getCountry();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDefaultBundleName() {
return bundleName;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String[] getBundleNames() {
return new String[] {bundleName};
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ResourceBundle getBundle() {
return bundle;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ResourceBundle getBundle(String bundleName) {
return bundle;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ResourceBundle getBundle(String bundleName, String languageHeader) {
return bundle;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ResourceBundle getBundle(String bundleName, Locale locale) {
return bundle;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public Locale getLocale(String languageHeader) {
return new Locale(languageHeader);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getString(String key) {
return getString(bundleName, locale, key);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getString(String key, Locale locale) {
return getString(bundleName, locale, key);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getString(String bundleName, Locale locale, String key) {
String value;
@@ -467,31 +495,41 @@ public String getString(String bundleName, Locale locale, String key) {
return value;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String format(String key, Object arg1) {
return format(bundleName, locale, key, new Object[] {arg1});
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String format(String key, Object arg1, Object arg2) {
return format(bundleName, locale, key, new Object[] {arg1, arg2});
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String format(String bundleName, Locale locale, String key, Object arg1) {
return format(bundleName, locale, key, new Object[] {arg1});
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String format(String bundleName, Locale locale, String key, Object arg1, Object arg2) {
return format(bundleName, locale, key, new Object[] {arg1, arg2});
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String format(String bundleName, Locale locale, String key, Object[] args) {
if (locale == null) {
diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java
index 3e0aa40..c9404b6 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java
@@ -49,6 +49,7 @@ public class FailsafeOnlyReport extends AbstractSurefireReport {
/**
* If set to true the failsafe report will be generated even when there are no failsafe result files.
* Defaults to {@code false} to preserve legacy behaviour pre 2.10.
+ *
* @since 2.11
*/
@Parameter(defaultValue = "false", property = "alwaysGenerateFailsafeReport")
@@ -56,6 +57,7 @@ public class FailsafeOnlyReport extends AbstractSurefireReport {
/**
* If set to true the failsafe report generation will be skipped.
+ *
* @since 2.11
*/
@Parameter(defaultValue = "false", property = "skipFailsafeReport")
diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/PluginConsoleLogger.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/PluginConsoleLogger.java
index ce668f0..e65e5b0 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/PluginConsoleLogger.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/PluginConsoleLogger.java
@@ -29,8 +29,8 @@
* Wrapper logger of miscellaneous implementations of {@link Log}.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.20
* @see ConsoleLogger
+ * @since 2.20
*/
final class PluginConsoleLogger implements ConsoleLogger {
private final Log mojoLogger;
diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java
index 29bdb0b..4a5e855 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java
@@ -48,6 +48,7 @@ public class SurefireReport extends AbstractSurefireReport {
/**
* If set to true, the surefire report will be generated even when there are no surefire result files.
* Defaults to {@code true} to preserve legacy behaviour pre 2.10.
+ *
* @since 2.11
*/
@Parameter(defaultValue = "true", property = "alwaysGenerateSurefireReport")
@@ -55,6 +56,7 @@ public class SurefireReport extends AbstractSurefireReport {
/**
* If set to true, the surefire report generation will be skipped.
+ *
* @since 2.11
*/
@Parameter(defaultValue = "false", property = "skipSurefireReport")
diff --git a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java
index 75d2528..6d76789 100644
--- a/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java
+++ b/maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java
@@ -79,8 +79,8 @@ public String getTitle() {
}
/**
- * @param key The key.
- * @return The translated string.
+ * @param key the key
+ * @return the translated string
*/
private String getI18nString(String key) {
return getI18nString(getI18nSection(), key);
@@ -91,19 +91,19 @@ private String getI18nSection() {
}
/**
- * @param section The section.
- * @param key The key to translate.
- * @return the translated key.
+ * @param section the section
+ * @param key the key to translate
+ * @return the translated key
*/
private String getI18nString(String section, String key) {
return i18n.getString("surefire-report", locale, "report." + section + '.' + key);
}
/**
- * @param section The section.
- * @param key The key to translate.
- * @param args The args to pass to translated string.
- * @return the translated key.
+ * @param section the section
+ * @param key the key to translate
+ * @param args the args to pass to translated string
+ * @return the translated key
*/
private String formatI18nString(String section, String key, Object... args) {
return i18n.format("surefire-report", locale, "report." + section + '.' + key, args);
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/BiProperty.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/BiProperty.java
index ebacde8..48b80c9 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/BiProperty.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/BiProperty.java
@@ -22,9 +22,9 @@
* Internal generic wrapper.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.19
* @param <P1> first property
* @param <P2> second property
+ * @since 2.19
*/
public final class BiProperty<P1, P2> {
private final P1 p1;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/Constants.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/Constants.java
index d57db47..2e2c1fa 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/Constants.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/booter/Constants.java
@@ -23,9 +23,6 @@
import static java.nio.charset.StandardCharsets.US_ASCII;
import static java.nio.charset.StandardCharsets.UTF_8;
-/**
- *
- */
public final class Constants {
private static final String MAGIC_NUMBER_FOR_EVENTS = "maven-surefire-event";
public static final String MAGIC_NUMBER_FOR_COMMANDS = "maven-surefire-command";
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/cli/CommandLineOption.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/cli/CommandLineOption.java
index d050201..5646191 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/cli/CommandLineOption.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/cli/CommandLineOption.java
@@ -26,8 +26,8 @@
* CLI options.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.19
* @see <a href="http://books.sonatype.com/mvnref-book/reference/running-sect-options.html">command line options</a>
+ * @since 2.19
*/
public enum CommandLineOption {
REACTOR_FAIL_FAST,
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/event/AbstractTestControlEvent.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/event/AbstractTestControlEvent.java
index 863a5eb..d7c64aa 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/event/AbstractTestControlEvent.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/event/AbstractTestControlEvent.java
@@ -24,8 +24,8 @@
/**
* The base class of an event of test control.
*
- * @since 3.0.0-M5
* @param <T> TestSetReportEntry or ReportEntry
+ * @since 3.0.0-M5
*/
public abstract class AbstractTestControlEvent<T extends ReportEntry> extends Event {
private final T reportEntry;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/filter/SpecificTestClassFilter.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/filter/SpecificTestClassFilter.java
index 5efc91c..b07a23b 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/filter/SpecificTestClassFilter.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/filter/SpecificTestClassFilter.java
@@ -26,8 +26,7 @@
import org.apache.maven.surefire.shared.utils.io.SelectorUtils;
/**
- * Filter for test class files
- *
+ * Filter for test class files.
*/
public class SpecificTestClassFilter implements ScannerFilter {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/AbstractProvider.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/AbstractProvider.java
index c24427e..ba26baf 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/AbstractProvider.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/AbstractProvider.java
@@ -19,7 +19,7 @@
package org.apache.maven.surefire.api.provider;
/**
- * A provider base class that all providers should extend to shield themselves from interface changes
+ * A provider base class that all providers should extend to shield themselves from interface changes.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/ProviderParameters.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/ProviderParameters.java
index 71cadda..55baf0b 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/ProviderParameters.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/ProviderParameters.java
@@ -44,60 +44,60 @@
public interface ProviderParameters {
/**
* Provides a directory scanner that enforces the includes/excludes parameters that were passed to surefire.
- * See #getDirectoryScannerParameters for details
+ * See #getDirectoryScannerParameters for details.
*
- * @return The directory scanner
- * @deprecated Use scanresult instead, as of version 2.12.2. Will be removed in next major version.
+ * @return the directory scanner
+ * @deprecated use scanresult instead, as of version 2.12.2. Will be removed in next major version.
*/
@Deprecated
DirectoryScanner getDirectoryScanner();
/**
- * Provides the result of the directory scan performed in the plugin
+ * Provides the result of the directory scan performed in the plugin.
*
- * @return The scan result
+ * @return the scan result
*/
ScanResult getScanResult();
/**
* Provides a service to calculate run order of tests. Applied after directory scanning.
*
- * @return A RunOrderCalculator
+ * @return a RunOrderCalculator
*/
RunOrderCalculator getRunOrderCalculator();
/**
- * Provides features for creating reporting objects
+ * Provides features for creating reporting objects.
*
- * @return A ReporterFactory that allows the creation of one or more ReporterManagers
+ * @return a ReporterFactory that allows the creation of one or more ReporterManagers
*/
ReporterFactory getReporterFactory();
/**
- * The raw parameters used in creating the directory scanner
+ * The raw parameters used in creating the directory scanner.
*
- * @return The parameters
- * @deprecated Use scanresult instead, as of version 2.12.2. Will be removed in next major version.
+ * @return the parameters
+ * @deprecated use scanresult instead, as of version 2.12.2. Will be removed in next major version.
*/
@Deprecated
DirectoryScannerParameters getDirectoryScannerParameters();
/**
- * The raw parameters used in creating the ReporterManagerFactory
+ * The raw parameters used in creating the ReporterManagerFactory.
*
- * @return The reporter configuration
+ * @return the reporter configuration
*/
ReporterConfiguration getReporterConfiguration();
/**
* Contains information about requested test suites or individual tests from the command line.
*
- * @return The testRequest
+ * @return the testRequest
*/
TestRequest getTestRequest();
/**
- * The class loader for the tests
+ * The class loader for the tests.
*
* @return the classloader
*/
@@ -111,22 +111,22 @@ public interface ProviderParameters {
Map<String, String> getProviderProperties();
/**
- * Artifact info about the artifact used to autodetect provider
+ * Artifact info about the artifact used to autodetect provider.
*
- * @return The artifactinfo, or null if autodetect was not used.
+ * @return the artifactinfo, or null if autodetect was not used
*/
TestArtifactInfo getTestArtifactInfo();
List<CommandLineOption> getMainCliOptions();
/**
- * @return Defaults to 0. Configured with parameter {@code skipAfterFailureCount} in POM.
+ * @return defaults to 0. Configured with parameter {@code skipAfterFailureCount} in POM.
*/
int getSkipAfterFailureCount();
/**
* @return {@code true} if test provider appears in forked jvm; Otherwise {@code false} means
- * in-plugin provider.
+ * in-plugin provider
*/
boolean isInsideFork();
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/SurefireProvider.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/SurefireProvider.java
index a3194b3..891282e 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/SurefireProvider.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/provider/SurefireProvider.java
@@ -48,22 +48,22 @@ public interface SurefireProvider {
* Called when forkmode is different from "never" or "always", allows the provider to define
* how to behave for the fork.
*
- * @return An iterator that will trigger one fork per item
+ * @return an iterator that will trigger one fork per item
*/
Iterable<Class<?>> getSuites();
/**
- * Runs a forked test
+ * Runs a forked test.
*
- * @param forkTestSet An item from the iterator in #getSuites. Will be null for forkmode never or always.
+ * @param forkTestSet an item from the iterator in #getSuites. Will be null for forkmode never or always.
* When this is non-null, the forked process will run only that test
* and probably not scan the classpath
- * @return A result of the invocation
+ * @return a result of the invocation
+ * @throws InvocationTargetException fails in {@code ProviderFactory}
* @throws ReporterException
* When reporting fails
* @throws TestSetFailedException
* When testset fails
- * @throws InvocationTargetException fails in {@code ProviderFactory}
*/
@SuppressWarnings("checkstyle:redundantthrows")
RunResult invoke(Object forkTestSet) throws TestSetFailedException, ReporterException, InvocationTargetException;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java
index 804766d..cb08ae9 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java
@@ -21,14 +21,13 @@
import javax.annotation.Nonnull;
/**
- * Describes a single entry for a test report
- *
+ * Describes a single entry for a test report.
*/
public interface ReportEntry {
/**
- * The class name of the test
+ * The class name of the test.
*
- * @return A string with the class name
+ * @return a string with the class name
*/
String getSourceName();
@@ -40,9 +39,9 @@ public interface ReportEntry {
String getSourceText();
/**
- * The name of the test case
+ * The name of the test case.
*
- * @return A string describing the test case
+ * @return a string describing the test case
*/
String getName();
@@ -54,14 +53,14 @@ public interface ReportEntry {
String getNameText();
/**
- * The group/category of the testcase
+ * The group/category of the testcase.
*
- * @return A string
+ * @return a string
*/
String getGroup();
/**
- * The group/category of the testcase
+ * The group/category of the testcase.
*
* @return stack trace object
*/
@@ -71,6 +70,7 @@ public interface ReportEntry {
* Gets the runtime for the item. Optional parameter. If the value is not set, it will be determined within
* the reporting subsystem. Some providers like to calculate this value themselves, and it gets the
* most accurate value.
+ *
* @return duration of a test in milliseconds
*/
Integer getElapsed();
@@ -86,23 +86,23 @@ public interface ReportEntry {
/**
* A message relating to a non-successful termination.
- * May be the "message" from an exception or the reason for a test being ignored
+ * May be the "message" from an exception or the reason for a test being ignored.
*
- * @return A string that explains an anomaly
+ * @return a string that explains an anomaly
*/
String getMessage();
/**
* A source name of the test case together with the group or category (if any exists).
*
- * @return A string with the test case name and group/category, or just the name.
+ * @return a string with the test case name and group/category, or just the name
*/
String getNameWithGroup();
/**
* A source text of the test case together with the group or category (if any exists).
*
- * @return A string with the test case text and group/category, or just the source text. If no
+ * @return a string with the test case text and group/category, or just the source text. If no
* source text is provided, then this will return null.
*/
String getReportNameWithGroup();
@@ -110,7 +110,7 @@ public interface ReportEntry {
/**
* Run mode.
*
- * @return a normal run, or re-run.
+ * @return a normal run, or re-run
*/
@Nonnull
RunMode getRunMode();
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterConfiguration.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterConfiguration.java
index 532d18f..0b19f21 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterConfiguration.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterConfiguration.java
@@ -23,7 +23,7 @@
/**
* Bits and pieces of reporting configuration that seem to be necessary on the provider side.
* <br>
- * Todo: Consider moving these fields elsewhere, this concept does not smell too good
+ * Todo: Consider moving these fields elsewhere, this concept does not smell too good.
*
* @author Kristian Rosenvold
*/
@@ -37,9 +37,9 @@ public ReporterConfiguration(File reportsDirectory, boolean trimStackTrace) {
}
/**
- * The directory where reports will be created, normally ${project.build.directory}/surefire-reports
+ * The directory where reports will be created, normally ${project.build.directory}/surefire-reports.
*
- * @return A file pointing at the specified directory
+ * @return a file pointing at the specified directory
*/
public File getReportsDirectory() {
return reportsDirectory;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactory.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactory.java
index 80dde24..73cd1a0 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactory.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactory.java
@@ -36,7 +36,7 @@ public interface ReporterFactory {
/**
* Closes the factory, freeing resources allocated in the factory.
*
- * @return The run result
+ * @return the run result
*/
RunResult close();
}
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactoryOptions.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactoryOptions.java
index fcdac04..82a0aad 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactoryOptions.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactoryOptions.java
@@ -22,7 +22,7 @@
public class ReporterFactoryOptions {
/**
- * provider such Junit5 may be running tests in parallel so report will stored depending on
+ * Provider such Junit5 may be running tests in parallel so report will stored depending on
* {@link ReportEntry#getSourceName()}
*/
private boolean statPerSourceName;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/RunListener.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/RunListener.java
index 799891c..bc8b40a 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/RunListener.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/RunListener.java
@@ -29,61 +29,61 @@
*/
public interface RunListener {
/**
- * Indicates the start of a given test-set
+ * Indicates the start of a given test-set.
*
* @param report the report entry describing the testset
- * @throws ReporterException When reporting fails
+ * @throws ReporterException when reporting fails
*/
void testSetStarting(TestSetReportEntry report);
/**
- * Indicates end of a given test-set
+ * Indicates end of a given test-set.
*
* @param report the report entry describing the testset
- * @throws ReporterException When reporting fails
+ * @throws ReporterException when reporting fails
*/
void testSetCompleted(TestSetReportEntry report);
/**
- * Event fired when a test is about to start
+ * Event fired when a test is about to start.
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testStarting(ReportEntry report);
/**
- * Event fired when a test ended successfully
+ * Event fired when a test ended successfully.
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testSucceeded(ReportEntry report);
/**
* Event fired when a test assumption failure was encountered.
- * An assumption failure indicates that the test is not relevant
+ * An assumption failure indicates that the test is not relevant.
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testAssumptionFailure(ReportEntry report);
/**
* Event fired when a test ended with an error (non anticipated problem)
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testError(ReportEntry report);
/**
* Event fired when a test ended with a failure (anticipated problem)
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testFailed(ReportEntry report);
/**
- * Event fired when a test is skipped
+ * Event fired when a test is skipped.
*
- * @param report The report entry to log for
+ * @param report the report entry to log for
*/
void testSkipped(ReportEntry report);
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/SafeThrowable.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/SafeThrowable.java
index d639d28..6e36ac3 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/SafeThrowable.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/SafeThrowable.java
@@ -19,7 +19,7 @@
package org.apache.maven.surefire.api.report;
/**
- * Guards against misbehaving throwables
+ * Guards against misbehaving throwables.
*/
public class SafeThrowable {
private final Throwable target;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReceiver.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReceiver.java
index d1ce28e..6766e0f 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReceiver.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReceiver.java
@@ -27,7 +27,7 @@
public interface TestOutputReceiver<T extends OutputReportEntry> {
/**
- * Forwards process output from the running test-case into the reporting system
+ * Forwards process output from the running test-case into the reporting system.
*
* @param reportEntry wraps test output with descriptive information of the output
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReportEntry.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReportEntry.java
index 3c4c46d..44eb9ad 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReportEntry.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReportEntry.java
@@ -34,7 +34,7 @@ public final class TestOutputReportEntry implements OutputReportEntry {
* Wraps the output from the running test-case.
*
* @param log stdout/sterr output from running tests
- * @param isStdOut Indicates if this is stdout
+ * @param isStdOut indicates if this is stdout
* @param newLine print on new line
* @param runMode the phase of testset
* @param testRunId unique id of the test run pointing to the test description
@@ -51,7 +51,7 @@ public TestOutputReportEntry(String log, boolean isStdOut, boolean newLine, RunM
* Wraps the output from the running test-case.
*
* @param log stdout/sterr output from running tests
- * @param isStdOut Indicates if this is stdout
+ * @param isStdOut indicates if this is stdout
* @param newLine print on new line
*/
private TestOutputReportEntry(String log, boolean isStdOut, boolean newLine) {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/runorder/Priority.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/runorder/Priority.java
index fa06bb5..560f337 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/runorder/Priority.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/runorder/Priority.java
@@ -37,8 +37,8 @@ public Priority(String className) {
/**
* Returns a priority that applies to a new testclass (that has never been run/recorded)
*
- * @param className The class name
- * @return A priority
+ * @param className the class name
+ * @return a priority
*/
public static Priority newTestClassPriority(String className) {
Priority priority1 = new Priority(className);
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
index 400f74f..f687a26 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
@@ -355,9 +355,6 @@ protected final void printRemainingStream(Memento memento) {
memento.getLine().clear();
}
- /**
- *
- */
public static final class Segment {
private final byte[] array;
private final int fromIndex;
@@ -447,9 +444,6 @@ private StreamReadStatus read(ByteBuffer buffer, int oldPosition, int recommende
}
}
- /**
- *
- */
public final class Memento {
private CharsetDecoder currentDecoder;
private final CharsetDecoder defaultDecoder;
@@ -617,9 +611,6 @@ private boolean isJvmError(String line) {
}
}
- /**
- *
- */
public static final class MalformedFrameException extends Exception {
private final int readFrom;
private final int readTo;
@@ -647,7 +638,7 @@ public boolean hasValidPositions() {
* <br>
* Overflow - read all bytes or more
* <br>
- * EOF - end of stream
+ * EOF - end of stream.
*/
public enum StreamReadStatus {
UNDERFLOW,
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamEncoder.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamEncoder.java
index eba5246..82fdb79 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamEncoder.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamEncoder.java
@@ -36,6 +36,7 @@
/**
* The base class of stream encoder.
* The type of message is expressed by opcode where the opcode object is described by the generic type {@link E}.
+ *
* @param <E> type of the message
*/
public abstract class AbstractStreamEncoder<E extends Enum<E>> {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
index 2bd2121..bbedfb7 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
@@ -18,7 +18,4 @@
*/
package org.apache.maven.surefire.api.stream;
-/**
- *
- */
public class MalformedChannelException extends Exception {}
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/SegmentType.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/SegmentType.java
index 07f01d9..8cd0105 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/SegmentType.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/SegmentType.java
@@ -18,9 +18,6 @@
*/
package org.apache.maven.surefire.api.stream;
-/**
- *
- */
public enum SegmentType {
RUN_MODE,
TEST_RUN_ID,
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/DirectoryScannerParameters.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/DirectoryScannerParameters.java
index afff641..a0e4a41 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/DirectoryScannerParameters.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/DirectoryScannerParameters.java
@@ -75,7 +75,7 @@ public List<String> getSpecificTests() {
/**
* Returns the directory of the compiled classes, normally ${project.build.testOutputDirectory}
*
- * @return A directory that can be scanned for .class files
+ * @return a directory that can be scanned for .class files
*/
public File getTestClassesDirectory() {
return testClassesDirectory;
@@ -84,7 +84,7 @@ public File getTestClassesDirectory() {
/**
* The includes pattern list, as specified on the plugin includes parameter.
*
- * @return A list of patterns. May contain both source file designators and .class extensions.
+ * @return a list of patterns. May contain both source file designators and .class extensions.
*/
@Deprecated
public List<String> getIncludes() {
@@ -94,7 +94,7 @@ public List<String> getIncludes() {
/**
* The excludes pattern list, as specified on the plugin includes parameter.
*
- * @return A list of patterns. May contain both source file designators and .class extensions.
+ * @return a list of patterns. May contain both source file designators and .class extensions.
*/
@Deprecated
public List<String> getExcludes() {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/ResolvedTest.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/ResolvedTest.java
index 9e976c2..915894f 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/ResolvedTest.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/ResolvedTest.java
@@ -33,6 +33,7 @@
/**
* Single pattern test filter resolved from multi pattern filter -Dtest=MyTest#test,AnotherTest#otherTest.
+ *
* @deprecated will be renamed to ResolvedTestPattern
*/
// will be renamed to ResolvedTestPattern
@@ -125,7 +126,7 @@ public ResolvedTest(Type type, String pattern, boolean isRegex) {
* Other examples: org/animals/Cat*, org/animals/Ca?.class, %regex[Cat.class|Dog.*]<br>
* <br>
* '*' means zero or more characters<br>
- * '?' means one and only one character
+ * '?' means one and only one character.
*
* @return class pattern or regex
*/
@@ -142,7 +143,7 @@ public boolean hasTestClassPattern() {
* Other examples: test* or testSomethin? or %regex[testOne|testTwo] or %ant[testOne|testTwo]<br>
* <br>
* '*' means zero or more characters<br>
- * '?' means one and only one character
+ * '?' means one and only one character.
*
* @return method pattern or regex
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestArtifactInfo.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestArtifactInfo.java
index 0ff272c..bba2e59 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestArtifactInfo.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestArtifactInfo.java
@@ -19,7 +19,7 @@
package org.apache.maven.surefire.api.testset;
/**
- * Contains information about the detected test artifact
+ * Contains information about the detected test artifact.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestListResolver.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestListResolver.java
index ab8938d..492cc95 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestListResolver.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestListResolver.java
@@ -127,10 +127,9 @@ public boolean hasMethodPatterns() {
}
/**
- *
* @param resolver filter possibly having method patterns
* @return {@code resolver} if {@link TestListResolver#hasMethodPatterns() resolver.hasMethodPatterns()}
- * returns {@code true}; Otherwise wildcard filter {@code *.class} is returned.
+ * returns {@code true}; Otherwise wildcard filter {@code *.class} is returned
*/
public static TestListResolver optionallyWildcardFilter(TestListResolver resolver) {
return resolver.hasMethodPatterns() ? resolver : WILDCARD;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestRequest.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestRequest.java
index e5fe681..0acc7b6 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestRequest.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestRequest.java
@@ -49,9 +49,9 @@ public TestRequest(
}
/**
- * Represents suitexmlfiles that define the test-run request
+ * Represents suitexmlfiles that define the test-run request.
*
- * @return A list of java.io.File objects.
+ * @return a list of java.io.File objects
*/
public List<File> getSuiteXmlFiles() {
return suiteXmlFiles;
@@ -60,7 +60,7 @@ public List<File> getSuiteXmlFiles() {
/**
* Test source directory, normally ${project.build.testSourceDirectory}
*
- * @return A file pointing to test sources
+ * @return a file pointing to test sources
*/
public File getTestSourceDirectory() {
return testSourceDirectory;
@@ -78,7 +78,7 @@ public TestListResolver getTestListResolver() {
/**
* How many times to rerun failing tests, issued with -Dsurefire.rerunFailingTestsCount from the command line.
*
- * @return The int parameter to indicate how many times to rerun failing tests
+ * @return the int parameter to indicate how many times to rerun failing tests
*/
public int getRerunFailingTestsCount() {
return rerunFailingTestsCount;
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestSetFailedException.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestSetFailedException.java
index d1ea14f..461be8a 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestSetFailedException.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestSetFailedException.java
@@ -28,7 +28,7 @@ public class TestSetFailedException extends Exception {
/**
* Creates {@code TestSetFailedException} with a detail message.
*
- * @param message A detail message for this {@code TestSetFailedException}, or
+ * @param message a detail message for this {@code TestSetFailedException}, or
* {@code null}. If {@code null} is passed, the {@link #getMessage}
* method will return an empty {@link String string}.
*/
@@ -44,7 +44,7 @@ public TestSetFailedException(String message) {
* <b>NOT</b> automatically incorporated in this throwable's detail
* message.
*
- * @param message A detail message for this {@code TestSetFailedException}, or {@code null}.
+ * @param message a detail message for this {@code TestSetFailedException}, or {@code null}
* @param cause the cause, which is saved for later retrieval by the {@link #getCause} method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
@@ -56,7 +56,7 @@ public TestSetFailedException(String message, Throwable cause) {
* Creates {@code TestSetFailedException} with the specified cause. The mthod {@link #getMessage} method of this
* exception object will return {@code cause == null ? "" : cause.toString()}.
*
- * @param cause The cause
+ * @param cause the cause
*/
public TestSetFailedException(Throwable cause) {
super(cause == null ? "" : cause.toString(), cause);
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/CloseableIterator.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/CloseableIterator.java
index c197461..5c4d140 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/CloseableIterator.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/CloseableIterator.java
@@ -28,9 +28,8 @@
* method {@link #next()} throws {@link java.util.NoSuchElementException}.
* The method {@link #remove()} throws {@link IllegalStateException} if the iterator has been closed.
*
- * @param <T> the type of elements returned by this iterator
- *
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
+ * @param <T> the type of elements returned by this iterator
* @since 2.19.1
*/
public abstract class CloseableIterator<T> implements Iterator<T> {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DefaultRunOrderCalculator.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DefaultRunOrderCalculator.java
index 4e79468..524f4bc 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DefaultRunOrderCalculator.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DefaultRunOrderCalculator.java
@@ -30,7 +30,7 @@
import org.apache.maven.surefire.api.testset.RunOrderParameters;
/**
- * Applies the final runorder of the tests
+ * Applies the final runorder of the tests.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DirectoryScanner.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DirectoryScanner.java
index 41fde03..bd59c60 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DirectoryScanner.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/DirectoryScanner.java
@@ -24,11 +24,11 @@
@Deprecated
public interface DirectoryScanner {
/**
- * Locates tests based on scanning directories
+ * Locates tests based on scanning directories.
*
- * @param classLoader The classloader to use when loading classes
- * @param scannerFilter The filter to include/exclude test classes
- * @return The found classes that match the filter
+ * @param classLoader the classloader to use when loading classes
+ * @param scannerFilter the filter to include/exclude test classes
+ * @return the found classes that match the filter
*/
TestsToRun locateTestClasses(ClassLoader classLoader, ScannerFilter scannerFilter);
}
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/RunOrder.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/RunOrder.java
index c8b2612..7e9c940 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/RunOrder.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/RunOrder.java
@@ -45,7 +45,7 @@ public class RunOrder {
public static final RunOrder[] DEFAULT = new RunOrder[] {FILESYSTEM};
/**
- * Returns the specified RunOrder
+ * Returns the specified RunOrder.
*
* @param values the runorder string value
* @return an array of RunOrder objects, never null
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/ScannerFilter.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/ScannerFilter.java
index 61eaa5b..5428500 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/ScannerFilter.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/ScannerFilter.java
@@ -23,10 +23,10 @@
*/
public interface ScannerFilter {
/**
- * Indicates if the class should be accepted by the directory scanner
+ * Indicates if the class should be accepted by the directory scanner.
*
- * @param testClass The class in question
- * @return true if the class should be part of the directory scan result.
+ * @param testClass the class in question
+ * @return true if the class should be part of the directory scan result
*/
boolean accept(Class testClass);
}
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/SurefireReflectionException.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/SurefireReflectionException.java
index e105ab1..b07ef00 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/SurefireReflectionException.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/SurefireReflectionException.java
@@ -30,7 +30,7 @@ public class SurefireReflectionException extends RuntimeException {
* Create a {@link SurefireReflectionException} with the specified cause. The method {@link #getMessage} of this
* exception object will return {@code cause == null ? "" : cause.toString()}.
*
- * @param cause The cause of this exception
+ * @param cause the cause of this exception
*/
public SurefireReflectionException(Throwable cause) {
super(cause == null ? "" : cause.toString(), cause);
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TempFileManager.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TempFileManager.java
index ddf9800..eda6cdf 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TempFileManager.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TempFileManager.java
@@ -82,6 +82,7 @@ public static TempFileManager instance() {
/**
* Creates an instance using a subdirectory of the system's temporary directory.
+ *
* @param subDirName name of subdirectory
* @return instance
*/
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TestsToRun.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TestsToRun.java
index c6a9541..43f3218 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TestsToRun.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/TestsToRun.java
@@ -43,9 +43,9 @@ public class TestsToRun implements Iterable<Class<?>> {
private int iteratedCount;
/**
- * Constructor
+ * Constructor.
*
- * @param locatedClasses A set of java.lang.Class objects representing tests to run
+ * @param locatedClasses a set of java.lang.Class objects representing tests to run
*/
public TestsToRun(Set<Class<?>> locatedClasses) {
this.locatedClasses = new ArrayList<>(locatedClasses);
@@ -56,14 +56,14 @@ public static TestsToRun fromClass(Class<?> clazz) throws TestSetFailedException
}
/**
- * @return test classes which have been retrieved by {@link TestsToRun#iterator()}.
+ * @return test classes which have been retrieved by {@link TestsToRun#iterator()}
*/
public Iterator<Class<?>> iterated() {
return newWeakIterator();
}
/**
- * Returns an iterator over the located java.lang.Class objects
+ * Returns an iterator over the located java.lang.Class objects.
*
* @return an unmodifiable iterator
*/
@@ -163,10 +163,10 @@ public boolean allowEagerReading() {
}
/**
- * Get test class which matches className
+ * Get test class which matches className.
*
* @param className string used to find the test class
- * @return Class object with the matching name, null if could not find a class with the matching name
+ * @return class object with the matching name, null if could not find a class with the matching name
*/
public Class<?> getClassByName(String className) {
for (Class<?> clazz : this) {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/DaemonThreadFactory.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/DaemonThreadFactory.java
index 90bec08..eabc5cf 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/DaemonThreadFactory.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/DaemonThreadFactory.java
@@ -48,6 +48,7 @@ public Thread newThread(Runnable r) {
/**
* Should be used by thread pools.
+ *
* @return new instance of {@link ThreadFactory} where each {@link Thread thread} is daemon
*/
public static ThreadFactory newDaemonThreadFactory() {
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/StringUtils.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/StringUtils.java
index 67265e2..efae29f 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/StringUtils.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/StringUtils.java
@@ -74,9 +74,9 @@ private StringUtils() {
/**
* Determines if {@code buffer} starts with specific literal(s).
*
- * @param buffer Examined StringBuffer
+ * @param buffer examined StringBuffer
* @param pattern a pattern which should start in {@code buffer}
- * @return {@code true} if buffer's literal starts with given {@code pattern}, or both are empty.
+ * @return {@code true} if buffer's literal starts with given {@code pattern}, or both are empty
*/
public static boolean startsWith(StringBuffer buffer, String pattern) {
if (buffer.length() < pattern.length()) {
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/AbstractPathConfiguration.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/AbstractPathConfiguration.java
index d02a3ba..de90e13 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/AbstractPathConfiguration.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/AbstractPathConfiguration.java
@@ -61,14 +61,14 @@ protected AbstractPathConfiguration(
/**
* Must be exclusive with {@link #isClassPathConfig()}.
*
- * @return {@code true} if <code>this</code> is {@link ModularClasspathConfiguration}.
+ * @return {@code true} if <code>this</code> is {@link ModularClasspathConfiguration}
*/
public abstract boolean isModularPathConfig();
/**
* Must be exclusive with {@link #isModularPathConfig()}.
*
- * @return {@code true} if <code>this</code> is {@link ClasspathConfiguration}.
+ * @return {@code true} if <code>this</code> is {@link ClasspathConfiguration}
*/
public abstract boolean isClassPathConfig();
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterConstants.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterConstants.java
index b736bd7..61fc3ab 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterConstants.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterConstants.java
@@ -19,7 +19,7 @@
package org.apache.maven.surefire.booter;
/**
- * Constants used by the serializer/deserializer
+ * Constants used by the serializer/deserializer.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterDeserializer.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterDeserializer.java
index 8cf0e84..0db7f5c 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterDeserializer.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterDeserializer.java
@@ -73,7 +73,7 @@ public String getConnectionString() {
}
/**
- * @return PID of Maven process where plugin is executed; or null if PID could not be determined.
+ * @return PID of Maven process where plugin is executed; or null if PID could not be determined
*/
public String getPluginPid() {
return properties.getProperty(PLUGIN_PID);
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/Classpath.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/Classpath.java
index e340903..3dffd98 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/Classpath.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/Classpath.java
@@ -36,7 +36,7 @@
*
* A Classpath is immutable and thread safe.
*
- * Immutable and thread safe
+ * Immutable and thread safe.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ClasspathConfiguration.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ClasspathConfiguration.java
index 069a08d..93a7975 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ClasspathConfiguration.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ClasspathConfiguration.java
@@ -34,7 +34,7 @@ public class ClasspathConfiguration extends AbstractPathConfiguration {
private final Classpath testClasspathUrls;
/**
- * The surefire classpath to use when invoking in-process with the plugin
+ * The surefire classpath to use when invoking in-process with the plugin.
*/
private final Classpath inprocClasspath;
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/CommandReader.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/CommandReader.java
index b1dba3b..18deb3e 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/CommandReader.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/CommandReader.java
@@ -133,7 +133,7 @@ private void addListener(MasterProcessCommand cmd, CommandListener listener) {
/**
* @return test classes which have been retrieved by
- * {@link CommandReader#getIterableClasses(MasterProcessChannelEncoder)}.
+ * {@link CommandReader#getIterableClasses(MasterProcessChannelEncoder)}
*/
Iterator<String> iterated() {
return testClasses.subList(0, iteratedCount).iterator();
@@ -144,7 +144,7 @@ Iterator<String> iterated() {
* Two simultaneous instances are not allowed for sake of only one {@link #nextCommandNotifier}.
*
* @param eventChannel original stream in current JVM process
- * @return Iterator with test classes lazily loaded as commands from the main process
+ * @return iterator with test classes lazily loaded as commands from the main process
*/
Iterable<String> getIterableClasses(MasterProcessChannelEncoder eventChannel) {
return new ClassesIterable(eventChannel);
@@ -164,7 +164,7 @@ private boolean isStopped() {
}
/**
- * @return {@code true} if {@link #LAST_TEST_SYMBOL} found at the last index in {@link #testClasses}.
+ * @return {@code true} if {@link #LAST_TEST_SYMBOL} found at the last index in {@link #testClasses}
*/
private boolean isQueueFull() {
// The problem with COWAL is that such collection doe not have operation getLast, however it has get(int)
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedBooter.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedBooter.java
index 1bcdc8b..bccc78c 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedBooter.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedBooter.java
@@ -488,7 +488,7 @@ private static MasterProcessChannelProcessorFactory lookupDecoderFactory(String
* This method is invoked when Surefire is forked - this method parses and organizes the arguments passed to it and
* then calls the Surefire class' run method. <br> The system exit code will be 1 if an exception is thrown.
*
- * @param args Commandline arguments
+ * @param args commandline arguments
*/
public static void main(String[] args) {
ForkedBooter booter = new ForkedBooter();
@@ -496,7 +496,7 @@ public static void main(String[] args) {
}
/**
- * created for testing purposes.
+ * Created for testing purposes.
*
* @param booter booter in JVM
* @param args arguments passed to JVM
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedNodeArg.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedNodeArg.java
index c30aa7e..1c80435 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedNodeArg.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedNodeArg.java
@@ -27,9 +27,6 @@
import org.apache.maven.surefire.api.booter.DumpErrorSingleton;
import org.apache.maven.surefire.api.fork.ForkNodeArguments;
-/**
- *
- */
public final class ForkedNodeArg implements ForkNodeArguments {
private final int forkChannelId;
private final ConsoleLogger logger;
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/IsolatedClassLoader.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/IsolatedClassLoader.java
index a748ca7..c29e2df 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/IsolatedClassLoader.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/IsolatedClassLoader.java
@@ -47,7 +47,7 @@ public IsolatedClassLoader(ClassLoader parent, boolean childDelegation, String r
/**
* @deprecated this method will use {@link java.io.File} instead of {@link URL} in the next
- * major version.
+ * major version
*/
@Override
@Deprecated
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/KeyValueSource.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/KeyValueSource.java
index 7da898b..df1346f 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/KeyValueSource.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/KeyValueSource.java
@@ -21,7 +21,7 @@
import java.util.Map;
/**
- * A key-value source obeying the geneal constrains of java.util.Properties
+ * A key-value source obeying the geneal constrains of java.util.Properties.
*/
public interface KeyValueSource {
void copyTo(Map<Object, Object> target);
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/LazyTestsToRun.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/LazyTestsToRun.java
index 1dff93c..ffa649e 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/LazyTestsToRun.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/LazyTestsToRun.java
@@ -45,7 +45,7 @@ final class LazyTestsToRun extends TestsToRun {
private final CommandReader commandReader;
/**
- * C'tor
+ * C'tor.
*
* @param eventChannel the output stream to use when requesting new new tests
*/
@@ -76,7 +76,7 @@ public void remove() {
}
/**
- * @return test classes which have been retrieved by {@link LazyTestsToRun#iterator()}.
+ * @return test classes which have been retrieved by {@link LazyTestsToRun#iterator()}
*/
@Override
public Iterator<Class<?>> iterated() {
@@ -86,8 +86,9 @@ public Iterator<Class<?>> iterated() {
/**
* The iterator can be used only in one Thread.
* {@inheritDoc}
+ *
* @see TestsToRun#iterator()
- * */
+ */
@Override
public Iterator<Class<?>> iterator() {
return new BlockingIterator();
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ModularClasspathConfiguration.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ModularClasspathConfiguration.java
index 6a31124..a322a86 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ModularClasspathConfiguration.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ModularClasspathConfiguration.java
@@ -33,7 +33,7 @@ public class ModularClasspathConfiguration extends AbstractPathConfiguration {
private final Classpath testClasspathUrls;
/**
- * The surefire classpath to use when invoking in-process with the plugin
+ * The surefire classpath to use when invoking in-process with the plugin.
*/
private final Classpath inprocClasspath;
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PpidChecker.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PpidChecker.java
index 2c836ea..3c4cbf7 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PpidChecker.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PpidChecker.java
@@ -309,7 +309,7 @@ private static void checkValid(Scanner scanner) throws IOException {
* https://technet.microsoft.com/en-us/library/ee198928.aspx <br>
* We use UTC time zone which avoids DST changes, see SUREFIRE-1512.
*
- * @return Windows WMIC format yyyymmddHHMMSS.xxx
+ * @return windows WMIC format yyyymmddHHMMSS.xxx
*/
private static SimpleDateFormat createWindowsCreationDateFormat() {
SimpleDateFormat formatter = new SimpleDateFormat("yyyyMMddHHmmss'.'SSS");
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ProcessCheckerType.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ProcessCheckerType.java
index 9b49055..a75c756 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ProcessCheckerType.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/ProcessCheckerType.java
@@ -20,9 +20,6 @@
import static org.apache.maven.surefire.shared.utils.StringUtils.isBlank;
-/**
- *
- */
public enum ProcessCheckerType {
PING("ping"),
NATIVE("native"),
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PropertiesWrapper.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PropertiesWrapper.java
index 91cdb4f..9d250c6 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PropertiesWrapper.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/PropertiesWrapper.java
@@ -88,10 +88,10 @@ public List<String> getStringList(String propertyPrefix) {
}
/**
- * Retrieves as single object that is persisted with type encoding
+ * Retrieves as single object that is persisted with type encoding.
*
- * @param key The key for the propery
- * @return The object, of a supported type
+ * @param key the key for the propery
+ * @return the object, of a supported type
*/
public TypeEncodedValue getTypeEncodedValue(String key) {
String typeEncoded = getProperty(key);
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SurefireReflector.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SurefireReflector.java
index 90d2279..4ec533b 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SurefireReflector.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SurefireReflector.java
@@ -52,7 +52,7 @@
/**
* Does reflection based invocation of the surefire methods.
* <br>
- * This is to avoid complications with linkage issues
+ * This is to avoid complications with linkage issues.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemPropertyManager.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemPropertyManager.java
index 84b93b8..a40ca22 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemPropertyManager.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemPropertyManager.java
@@ -35,11 +35,11 @@
public class SystemPropertyManager {
/**
- * Loads the properties, closes the stream
+ * Loads the properties, closes the stream.
*
- * @param inStream The stream to read from, will be closed
- * @return The properties
- * @throws java.io.IOException If something bad happens
+ * @param inStream the stream to read from, will be closed
+ * @return the properties
+ * @throws java.io.IOException if something bad happens
*/
public static PropertiesWrapper loadProperties(InputStream inStream) throws IOException {
try (InputStream stream = inStream) {
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemUtils.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemUtils.java
index 3f7b4aa..0a06a09 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemUtils.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemUtils.java
@@ -78,7 +78,7 @@ public static boolean endsWithJavaPath(String jvmExecPath) {
* Null is returned if {@code jvmExecutable} is incorrect.
*
* @param jvmExecutable /jdk/bin/java* or /jdk/jre/bin/java*
- * @return path to jdk directory; or <code>null</code> if wrong path or directory layout of JDK installation.
+ * @return path to jdk directory; or <code>null</code> if wrong path or directory layout of JDK installation
*/
public static File toJdkHomeFromJvmExec(String jvmExecutable) {
File bin = new File(jvmExecutable).getAbsoluteFile().getParentFile();
@@ -222,7 +222,7 @@ static Long pidOnJMX() {
* <br>
* $ echo $CPU_ID | gawk '{print $1}'
* <br>
- * 48982
+ * 48982.
*
* @return self PID
* @throws Exception i/o and number format exc
@@ -261,7 +261,7 @@ static Long pidStatusOnLinux(String root) throws Exception {
* Fields are:
* <br>
* comm pid ppid pgid sid maj, min ctty, sldr start user/system time wmsg euid ruid rgid,egid,
- * groups[1 .. NGROUPS] hostname
+ * groups[1 .. NGROUPS] hostname.
*
* @return current PID
* @throws Exception if could not read /proc/curproc/status
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
index 3c1a609..dd5243e 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
@@ -31,7 +31,7 @@
import org.apache.maven.surefire.booter.stream.CommandDecoder;
/**
- * magic number : opcode [: opcode specific data]*
+ * Magic number : opcode [: opcode specific data]*
* <br>
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/EventChannelEncoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/EventChannelEncoder.java
index 13df7fa..f2fdd71 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/EventChannelEncoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/EventChannelEncoder.java
@@ -66,7 +66,7 @@
import static org.apache.maven.surefire.api.booter.ForkedProcessEventType.BOOTERCODE_TEST_SUCCEEDED;
/**
- * magic number : opcode : run mode [: opcode specific data]*
+ * Magic number : opcode : run mode [: opcode specific data]*
* <br>
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
index 3a48ca9..41dffc2 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
@@ -50,9 +50,6 @@
import static org.apache.maven.surefire.api.stream.SegmentType.STRING_ENCODING;
import static org.apache.maven.surefire.shared.utils.cli.ShutdownHookUtils.addShutDownHook;
-/**
- *
- */
public class CommandDecoder extends AbstractStreamDecoder<Command, MasterProcessCommand, SegmentType> {
private static final int DEBUG_SINK_BUFFER_SIZE = 64 * 1024;
private static final int NO_POSITION = -1;
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/EventEncoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/EventEncoder.java
index ebc50f5..4750392 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/EventEncoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/EventEncoder.java
@@ -31,9 +31,6 @@
import static org.apache.maven.surefire.api.booter.Constants.DEFAULT_STREAM_ENCODING_BYTES;
import static org.apache.maven.surefire.api.booter.Constants.MAGIC_NUMBER_FOR_EVENTS_BYTES;
-/**
- *
- */
public class EventEncoder extends AbstractStreamEncoder<ForkedProcessEventType> {
public EventEncoder(WritableBufferedByteChannel out) {
super(out);
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ConsoleOutputReporter.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ConsoleOutputReporter.java
index 5f32f9b..ceaa394 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ConsoleOutputReporter.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ConsoleOutputReporter.java
@@ -32,7 +32,7 @@
*/
public abstract class ConsoleOutputReporter {
/**
- * {@code false} by default
+ * {@code false} by default.
*/
private boolean disable;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ForkChannel.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ForkChannel.java
index e942483..31821dc 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ForkChannel.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ForkChannel.java
@@ -46,7 +46,7 @@ public abstract class ForkChannel implements Closeable {
private final ForkNodeArguments arguments;
/**
- * @param arguments data necessary for command reader and event handler.
+ * @param arguments data necessary for command reader and event handler
*/
protected ForkChannel(@Nonnull ForkNodeArguments arguments) {
this.arguments = arguments;
@@ -55,8 +55,8 @@ protected ForkChannel(@Nonnull ForkNodeArguments arguments) {
/**
* Asynchronously connects to the client.
*
- * @throws IOException if stream fails
* @throws InterruptedException if interrupted thread
+ * @throws IOException if stream fails
*/
public abstract void tryConnectToClient() throws IOException, InterruptedException;
@@ -68,7 +68,7 @@ protected ForkChannel(@Nonnull ForkNodeArguments arguments) {
public abstract String getForkNodeConnectionString();
/**
- * the permits in {@link CountdownCloseable}.
+ * The permits in {@link CountdownCloseable}.
*/
public abstract int getCountdownCloseablePermits();
@@ -77,8 +77,8 @@ protected ForkChannel(@Nonnull ForkNodeArguments arguments) {
*
* @param commands command reader, see {@link CommandReader#readNextCommand()}
* @param stdIn optional standard input stream of the JVM to write the encoded commands into it
- * @throws IOException if an error in the fork channel
* @throws InterruptedException channel interrupted
+ * @throws IOException if an error in the fork channel
*/
public abstract void bindCommandReader(@Nonnull CommandReader commands, WritableByteChannel stdIn)
throws IOException, InterruptedException;
@@ -89,8 +89,8 @@ public abstract void bindCommandReader(@Nonnull CommandReader commands, Writable
* @param eventHandler event eventHandler
* @param countdownCloseable count down of the final call of {@link Closeable#close()}
* @param stdOut optional standard output stream of the JVM
- * @throws IOException if an error in the fork channel
* @throws InterruptedException channel interrupted
+ * @throws IOException if an error in the fork channel
*/
public abstract void bindEventHandler(
@Nonnull EventHandler<Event> eventHandler,
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReportEventListener.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReportEventListener.java
index 948c278..5db81f0 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReportEventListener.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReportEventListener.java
@@ -26,9 +26,10 @@
* Defaults to <em>org.apache.maven.plugin.surefire.report.StatelessXmlReporter</em>.
*
* author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
+ *
* @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
* @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
+ * @since 3.0.0-M4
*/
public interface StatelessReportEventListener<R extends TestSetReportEntry, S> {
/**
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReporter.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReporter.java
index da330c0..06fb83f 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReporter.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReporter.java
@@ -27,14 +27,14 @@
* Signatures can be changed between major, minor versions or milestones.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
* @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
* @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
* @param <C> mojo config, see <em>DefaultStatelessReportMojoConfiguration</em> from <em>maven-surefire-common</em>
+ * @since 3.0.0-M4
*/
public abstract class StatelessReporter<R extends TestSetReportEntry, S, C extends StatelessReportMojoConfiguration> {
/**
- * {@code false} by default
+ * {@code false} by default.
*/
private boolean disable;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoConsoleReportEventListener.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoConsoleReportEventListener.java
index 8ca3956..3072112 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoConsoleReportEventListener.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoConsoleReportEventListener.java
@@ -28,9 +28,9 @@
* Signatures can be changed between major, minor versions or milestones.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
* @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
* @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
+ * @since 3.0.0-M4
*/
public abstract class StatelessTestsetInfoConsoleReportEventListener<R extends TestSetReportEntry, S> {
private final ConsoleLogger logger;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoFileReportEventListener.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoFileReportEventListener.java
index 5713903..fd850b1 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoFileReportEventListener.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoFileReportEventListener.java
@@ -29,9 +29,9 @@
* Signatures can be changed between major, minor versions or milestones.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
* @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
* @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
+ * @since 3.0.0-M4
*/
public abstract class StatelessTestsetInfoFileReportEventListener<R extends TestSetReportEntry, S> {
private final File reportsDirectory;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoReporter.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoReporter.java
index f33cb53..60133b0 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoReporter.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoReporter.java
@@ -29,9 +29,9 @@
* Signatures can be changed between major, minor versions or milestones.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 3.0.0-M4
* @param <R> report entry type, see <em>WrappedReportEntry</em> from module the <em>maven-surefire-common</em>
* @param <S> test-set statistics, see <em>TestSetStats</em> from module the <em>maven-surefire-common</em>
+ * @since 3.0.0-M4
*/
public abstract class StatelessTestsetInfoReporter<R extends TestSetReportEntry, S> {
private boolean disable;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineExecutor.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineExecutor.java
index 737fd5a..9f517c8 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineExecutor.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineExecutor.java
@@ -106,7 +106,9 @@ private ProcessHook(Process process) {
setDaemon(true);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void run() {
process.destroy();
}
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineStreams.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineStreams.java
index 489d106..d181a88 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineStreams.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineStreams.java
@@ -31,9 +31,6 @@
import static org.apache.maven.surefire.api.util.internal.Channels.newBufferedChannel;
import static org.apache.maven.surefire.api.util.internal.Channels.newChannel;
-/**
- *
- */
public final class CommandlineStreams implements Closeable {
private final ReadableByteChannel stdOutChannel;
private final ReadableByteChannel stdErrChannel;
diff --git a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/LineConsumerThread.java b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/LineConsumerThread.java
index c24d16e..fd9b642 100644
--- a/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/LineConsumerThread.java
+++ b/surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/LineConsumerThread.java
@@ -29,9 +29,6 @@
import org.apache.maven.surefire.extensions.CloseableDaemonThread;
import org.apache.maven.surefire.extensions.EventHandler;
-/**
- *
- */
public final class LineConsumerThread extends CloseableDaemonThread {
private final Charset encoding;
private final ReadableByteChannel channel;
diff --git a/surefire-extensions-spi/src/main/java/org/apache/maven/surefire/spi/MasterProcessChannelProcessorFactory.java b/surefire-extensions-spi/src/main/java/org/apache/maven/surefire/spi/MasterProcessChannelProcessorFactory.java
index fd77010..a409cc5 100644
--- a/surefire-extensions-spi/src/main/java/org/apache/maven/surefire/spi/MasterProcessChannelProcessorFactory.java
+++ b/surefire-extensions-spi/src/main/java/org/apache/maven/surefire/spi/MasterProcessChannelProcessorFactory.java
@@ -49,6 +49,7 @@ public interface MasterProcessChannelProcessorFactory extends Closeable {
/**
* Decoder factory method.
+ *
* @param forkingArguments forking arguments
* @return a new instance of decoder
*/
@@ -56,6 +57,7 @@ public interface MasterProcessChannelProcessorFactory extends Closeable {
/**
* Encoder factory method.
+ *
* @param forkingArguments forking arguments
* @return a new instance of encoder
*/
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/AndGroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/AndGroupMatcher.java
index e50a328..3a09f10 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/AndGroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/AndGroupMatcher.java
@@ -21,8 +21,7 @@
import java.util.Collection;
/**
- * AND group matcher
- *
+ * AND group matcher.
*/
public class AndGroupMatcher extends JoinGroupMatcher {
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/GroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/GroupMatcher.java
index a5b2cae..ac76965 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/GroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/GroupMatcher.java
@@ -19,8 +19,7 @@
package org.apache.maven.surefire.group.match;
/**
- * Group Matcher
- *
+ * Group Matcher.
*/
public interface GroupMatcher {
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/InverseGroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/InverseGroupMatcher.java
index a75933f..bdacde6 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/InverseGroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/InverseGroupMatcher.java
@@ -19,8 +19,7 @@
package org.apache.maven.surefire.group.match;
/**
- * Inverse group matcher
- *
+ * Inverse group matcher.
*/
public class InverseGroupMatcher implements GroupMatcher {
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/JoinGroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/JoinGroupMatcher.java
index 4180e0e..bde4668 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/JoinGroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/JoinGroupMatcher.java
@@ -22,8 +22,7 @@
import java.util.Set;
/**
- * Joins several group matchers
- *
+ * Joins several group matchers.
*/
public abstract class JoinGroupMatcher implements GroupMatcher {
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/OrGroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/OrGroupMatcher.java
index 92dddba..9be7a43 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/OrGroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/OrGroupMatcher.java
@@ -21,8 +21,7 @@
import java.util.Collection;
/**
- * OR group matcher
- *
+ * OR group matcher.
*/
public class OrGroupMatcher extends JoinGroupMatcher {
diff --git a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/SingleGroupMatcher.java b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/SingleGroupMatcher.java
index 750cbd0..5194cbc 100644
--- a/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/SingleGroupMatcher.java
+++ b/surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/SingleGroupMatcher.java
@@ -22,8 +22,7 @@
import java.util.regex.PatternSyntaxException;
/**
- * Single group matcher
- *
+ * Single group matcher.
*/
public class SingleGroupMatcher implements GroupMatcher {
private final String enabled;
diff --git a/surefire-logger-api/src/main/java/org/apache/maven/plugin/surefire/log/api/Level.java b/surefire-logger-api/src/main/java/org/apache/maven/plugin/surefire/log/api/Level.java
index a99c04e..019f63b 100644
--- a/surefire-logger-api/src/main/java/org/apache/maven/plugin/surefire/log/api/Level.java
+++ b/surefire-logger-api/src/main/java/org/apache/maven/plugin/surefire/log/api/Level.java
@@ -27,22 +27,22 @@
*/
public enum Level {
/**
- * direct println
+ * Direct println.
*/
NO_COLOR,
/**
- * defaults to bold, green
+ * Defaults to bold, green.
*/
FAILURE,
/**
- * defaults to bold, yellow
+ * Defaults to bold, yellow.
*/
UNSTABLE,
/**
- * defaults to bold, red
+ * Defaults to bold, red.
*/
SUCCESS;
diff --git a/surefire-providers/common-java5/src/main/java/org/apache/maven/surefire/report/NullStackTraceFilter.java b/surefire-providers/common-java5/src/main/java/org/apache/maven/surefire/report/NullStackTraceFilter.java
index 629c77a..c338b6b 100644
--- a/surefire-providers/common-java5/src/main/java/org/apache/maven/surefire/report/NullStackTraceFilter.java
+++ b/surefire-providers/common-java5/src/main/java/org/apache/maven/surefire/report/NullStackTraceFilter.java
@@ -19,7 +19,7 @@
package org.apache.maven.surefire.report;
/**
- * always returns true
+ * Always returns true.
*/
final class NullStackTraceFilter implements StackTraceFilter {
@Override
diff --git a/surefire-providers/common-junit3/src/main/java/org/apache/maven/surefire/common/junit3/JUnit3Reflector.java b/surefire-providers/common-junit3/src/main/java/org/apache/maven/surefire/common/junit3/JUnit3Reflector.java
index ed76798..c8b86fa 100644
--- a/surefire-providers/common-junit3/src/main/java/org/apache/maven/surefire/common/junit3/JUnit3Reflector.java
+++ b/surefire-providers/common-junit3/src/main/java/org/apache/maven/surefire/common/junit3/JUnit3Reflector.java
@@ -26,8 +26,7 @@
import org.apache.maven.surefire.api.util.ReflectionUtils;
/**
- * Reflection facade for JUnit3 classes
- *
+ * Reflection facade for JUnit3 classes.
*/
public final class JUnit3Reflector {
private static final String TEST_CASE = "junit.framework.Test";
diff --git a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4ProviderUtil.java b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4ProviderUtil.java
index 4b88aad..6857581 100644
--- a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4ProviderUtil.java
+++ b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4ProviderUtil.java
@@ -33,11 +33,9 @@
import static org.junit.runner.Description.TEST_MECHANISM;
/**
- *
- * Utility method used among all JUnit4 providers
+ * Utility method used among all JUnit4 providers.
*
* @author Qingzhou Luo
- *
*/
public final class JUnit4ProviderUtil {
private JUnit4ProviderUtil() {
@@ -45,7 +43,7 @@ private JUnit4ProviderUtil() {
}
/**
- * Get all descriptions from a list of Failures
+ * Get all descriptions from a list of Failures.
*
* @param allFailures the list of failures for a given test class
* @return the list of descriptions
@@ -68,6 +66,7 @@ public static boolean isFailureInsideJUnitItself(Description failure) {
/**
* Java Patterns of regex is slower than cutting a substring.
+ *
* @param description method(class) or method[#](class) or method[#whatever-literals](class)
* @return method JUnit test method
*/
diff --git a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4Reflector.java b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4Reflector.java
index ba919b3..c75f09c 100644
--- a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4Reflector.java
+++ b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4Reflector.java
@@ -29,8 +29,7 @@
import static org.apache.maven.surefire.api.util.ReflectionUtils.tryGetMethod;
/**
- * JUnit4 reflection helper
- *
+ * JUnit4 reflection helper.
*/
public final class JUnit4Reflector {
private static final Class<?>[] PARAMS = {Class.class};
diff --git a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4RunListener.java b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4RunListener.java
index 09f7abc..0117a45 100644
--- a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4RunListener.java
+++ b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4RunListener.java
@@ -44,8 +44,7 @@
import static org.apache.maven.surefire.common.junit4.JUnit4Reflector.getAnnotatedIgnoreValue;
/**
- * RunListener for JUnit4, delegates to our own RunListener
- *
+ * RunListener for JUnit4, delegates to our own RunListener.
*/
public class JUnit4RunListener extends RunListener implements TestOutputReceiver<OutputReportEntry>, RunModeSetter {
protected final ClassMethodIndexer classMethodIndexer = new ClassMethodIndexer();
diff --git a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnitTestFailureListener.java b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnitTestFailureListener.java
index dc477d1..f212620 100644
--- a/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnitTestFailureListener.java
+++ b/surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnitTestFailureListener.java
@@ -25,7 +25,7 @@
import org.junit.runner.notification.RunListener;
/**
- * Test listener to record all the failures during one run
+ * Test listener to record all the failures during one run.
*
* @author Qingzhou Luo
*/
diff --git a/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/FilterFactory.java b/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/FilterFactory.java
index 45d21b7..4682a2d 100644
--- a/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/FilterFactory.java
+++ b/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/FilterFactory.java
@@ -46,7 +46,7 @@ public FilterFactory(ClassLoader testClassLoader) {
/**
* @return {@code true} if non-blank
* {@link ProviderParameterNames#TESTNG_GROUPS_PROP} and/or
- * {@link ProviderParameterNames#TESTNG_EXCLUDEDGROUPS_PROP} exists.
+ * {@link ProviderParameterNames#TESTNG_EXCLUDEDGROUPS_PROP} exists
*/
public boolean canCreateGroupFilter(Map<String, String> providerProperties) {
String groups = providerProperties.get(TESTNG_GROUPS_PROP);
diff --git a/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/JUnit48TestChecker.java b/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/JUnit48TestChecker.java
index 324eb87..96af928 100644
--- a/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/JUnit48TestChecker.java
+++ b/surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/JUnit48TestChecker.java
@@ -24,7 +24,8 @@
import org.junit.experimental.runners.Enclosed;
/**
- * Looks for additional junit48-like features
+ * Looks for additional junit48-like features.
+ *
* @author Geoff Denning
* @author Kristian Rosenvold
*/
diff --git a/surefire-providers/surefire-junit-platform/src/main/java/org/apache/maven/surefire/junitplatform/RunListenerAdapter.java b/surefire-providers/surefire-junit-platform/src/main/java/org/apache/maven/surefire/junitplatform/RunListenerAdapter.java
index 26f0e35..6efd5ef 100644
--- a/surefire-providers/surefire-junit-platform/src/main/java/org/apache/maven/surefire/junitplatform/RunListenerAdapter.java
+++ b/surefire-providers/surefire-junit-platform/src/main/java/org/apache/maven/surefire/junitplatform/RunListenerAdapter.java
@@ -305,7 +305,7 @@ private TestIdentifier findTopParent(TestIdentifier testIdentifier) {
}
/**
- * Checks if the test identifier has a parent ID but using reflection as it's only available from 1.8
+ * Checks if the test identifier has a parent ID but using reflection as it's only available from 1.8.
*
* @param testIdentifier the test identifier to check
* @return true if the test identifier has a parent ID, false otherwise
@@ -514,7 +514,7 @@ public String getClassDisplayName() {
}
/**
- * @return Map of tests that failed.
+ * @return map of tests that failed
*/
Map<TestIdentifier, TestExecutionResult> getFailures() {
return failures;
diff --git a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/JUnitTestSetExecutor.java b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/JUnitTestSetExecutor.java
index 2d113d3..f491209 100644
--- a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/JUnitTestSetExecutor.java
+++ b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/JUnitTestSetExecutor.java
@@ -26,8 +26,7 @@
import org.apache.maven.surefire.common.junit3.JUnit3Reflector;
/**
- * JUnit3 test set
- *
+ * JUnit3 test set.
*/
public final class JUnitTestSetExecutor implements SurefireTestSetExecutor {
private final JUnit3Reflector reflector;
diff --git a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSetExecutor.java b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSetExecutor.java
index f9769ae..21ded90 100644
--- a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSetExecutor.java
+++ b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSetExecutor.java
@@ -35,8 +35,7 @@
import static org.apache.maven.surefire.api.report.SimpleReportEntry.withException;
/**
- * Executes a JUnit3 test class
- *
+ * Executes a JUnit3 test class.
*/
public class PojoTestSetExecutor implements SurefireTestSetExecutor {
private static final String TEST_METHOD_PREFIX = "test";
diff --git a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/SurefireTestSetExecutor.java b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/SurefireTestSetExecutor.java
index 6379c6a..33835d8 100644
--- a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/SurefireTestSetExecutor.java
+++ b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/SurefireTestSetExecutor.java
@@ -21,8 +21,7 @@
import org.apache.maven.surefire.api.testset.TestSetFailedException;
/**
- * Describes a single test set
- *
+ * Describes a single test set.
*/
public interface SurefireTestSetExecutor {
void execute(Class<?> testClass, ClassLoader loader) throws TestSetFailedException;
diff --git a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/TestListenerInvocationHandler.java b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/TestListenerInvocationHandler.java
index 083d076..adfc431 100644
--- a/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/TestListenerInvocationHandler.java
+++ b/surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/TestListenerInvocationHandler.java
@@ -37,7 +37,6 @@
/**
* Invocation Handler for TestListener proxies to delegate to our {@link RunListener}
- *
*/
public class TestListenerInvocationHandler implements InvocationHandler {
// The String names of the four methods in interface junit.framework.TestListener
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/ConcurrentRunListener.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/ConcurrentRunListener.java
index cb819a0..db26d9a 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/ConcurrentRunListener.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/ConcurrentRunListener.java
@@ -37,10 +37,10 @@
* Stuff to remember about JUnit threading:
* parallel=classes; beforeClass/afterClass, constructor and all tests method run on same thread
* parallel=methods; beforeClass/afterClass run on main thread, constructor + each test method run on same thread
- * parallel=both; same as parallel=methods
+ * parallel=both; same as parallel=methods.
*
- * @see org.apache.maven.surefire.junitcore.JUnitCoreRunListener for details about regular junit run listening
* @author Kristian Rosenvold
+ * @see org.apache.maven.surefire.junitcore.JUnitCoreRunListener for details about regular junit run listening
*/
@Deprecated // remove this class after StatelessXmlReporter is capable of parallel test sets processing
abstract class ConcurrentRunListener implements TestReportListener<TestOutputReportEntry> {
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCore.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCore.java
index d4101ce..ef585de 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCore.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCore.java
@@ -30,8 +30,8 @@
* is called anyway in finally block.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
- * @since 2.19
* @see <a href="https://github.com/junit-team/junit/issues/1186">JUnit issue 1186</a>
+ * @since 2.19
*/
class JUnitCore {
private final Notifier notifier;
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreParameters.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreParameters.java
index 51eea78..8280224 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreParameters.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreParameters.java
@@ -121,8 +121,8 @@ public boolean isParallelSuites() {
}
/**
- * @deprecated Instead use the expression isParallelMethods() && isParallelClasses().
* @return {@code true} if classes and methods are both parallel
+ * @deprecated instead use the expression isParallelMethods() && isParallelClasses()
*/
@Deprecated
@SuppressWarnings("unused")
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreRunListener.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreRunListener.java
index 31a939f..c2e0a2c 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreRunListener.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreRunListener.java
@@ -43,7 +43,7 @@ final class JUnitCoreRunListener extends JUnit4RunListener {
/**
* @param reporter the report manager to log testing events to
- * @param classMethodCounts A map of methods
+ * @param classMethodCounts a map of methods
*/
JUnitCoreRunListener(ConcurrentRunListener reporter, Map<String, TestSet> classMethodCounts) {
super(reporter);
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreWrapper.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreWrapper.java
index 96fc928..eeab7fa 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreWrapper.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreWrapper.java
@@ -45,7 +45,7 @@
import static org.junit.runner.Request.classes;
/**
- * Encapsulates access to JUnitCore
+ * Encapsulates access to JUnitCore.
*
* @author Kristian Rosenvold
*/
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/LogicalStream.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/LogicalStream.java
index a4846be..6015275 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/LogicalStream.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/LogicalStream.java
@@ -25,7 +25,7 @@
import org.apache.maven.surefire.api.report.TestOutputReportEntry;
/**
- * A stream-like object that preserves ordering between stdout/stderr
+ * A stream-like object that preserves ordering between stdout/stderr.
*/
@Deprecated // remove this class after StatelessXmlReporter is capable of parallel test sets processing
final class LogicalStream {
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/TestMethod.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/TestMethod.java
index cdff242..307b032 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/TestMethod.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/TestMethod.java
@@ -31,7 +31,7 @@
* Represents the test-state of a single test method that is run.
* <br>
* Notes about thread safety: This instance is serially confined to 1-3 threads (construction, test-run, reporting),
- * without any actual parallel access
+ * without any actual parallel access.
*/
@Deprecated // remove this class after StatelessXmlReporter is capable of parallel test sets processing
class TestMethod implements TestOutputReceiver<TestOutputReportEntry> {
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Balancer.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Balancer.java
index bbaabb8..cbf4317 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Balancer.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Balancer.java
@@ -35,7 +35,7 @@ public interface Balancer {
* Acquires a permit from this balancer, blocking until one is available.
*
* @return {@code true} if current thread is <b>NOT</b> interrupted
- * while waiting for a permit.
+ * while waiting for a permit
*/
boolean acquirePermit();
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/BalancerFactory.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/BalancerFactory.java
index 58d2618..1202dfa 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/BalancerFactory.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/BalancerFactory.java
@@ -28,7 +28,8 @@ private BalancerFactory() {}
/**
* Infinite permits.
- * @return Balancer wih infinite permits
+ *
+ * @return balancer wih infinite permits
*/
public static Balancer createInfinitePermitsBalancer() {
return balancer(0, false);
@@ -39,7 +40,7 @@ public static Balancer createInfinitePermitsBalancer() {
* Fairness guarantees the waiting schedulers to wake up in order they acquired a permit.
*
* @param concurrency number of permits to acquire when maintaining concurrency on tests
- * @return Balancer with given number of permits
+ * @return balancer with given number of permits
*/
public static Balancer createBalancer(int concurrency) {
return balancer(concurrency, false);
@@ -50,7 +51,7 @@ public static Balancer createBalancer(int concurrency) {
* Fairness guarantees the waiting schedulers to wake up in order they acquired a permit.
*
* @param concurrency number of permits to acquire when maintaining concurrency on tests
- * @return Balancer with given number of permits
+ * @return balancer with given number of permits
*/
public static Balancer createBalancerWithFairness(int concurrency) {
return balancer(concurrency, true);
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ParallelComputerBuilder.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ParallelComputerBuilder.java
index 08f365c..49efe0d 100755
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ParallelComputerBuilder.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ParallelComputerBuilder.java
@@ -140,10 +140,10 @@ ParallelComputerBuilder useOnePool() {
}
/**
- * @param totalPoolSize Pool size where suites, classes and methods are executed in parallel.
+ * @param totalPoolSize pool size where suites, classes and methods are executed in parallel.
* If the <code>totalPoolSize</code> is {@link Integer#MAX_VALUE}, the pool capacity is not
* limited.
- * @throws IllegalArgumentException If <code>totalPoolSize</code> is < 1.
+ * @throws IllegalArgumentException if <code>totalPoolSize</code> is < 1
*/
ParallelComputerBuilder useOnePool(int totalPoolSize) {
if (totalPoolSize < 1) {
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Scheduler.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Scheduler.java
index b92f53f..7041863 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Scheduler.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Scheduler.java
@@ -146,7 +146,6 @@ public Scheduler(
* or {@link #Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy)}
* @param strategy scheduling strategy
* @param concurrency determines maximum concurrent children scheduled a time via {@link #schedule(Runnable)}
- *
* @see #Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy)
* @see #Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy, int)
*/
@@ -186,7 +185,7 @@ private void setController(Controller masterController) {
/**
* @param slave a slave scheduler to register
- * @return {@code true} if successfully registered the <code>slave</code>.
+ * @return {@code true} if successfully registered the <code>slave</code>
*/
private boolean register(Scheduler slave) {
boolean canRegister = slave != null && slave != this;
@@ -202,7 +201,7 @@ private boolean register(Scheduler slave) {
}
/**
- * @return {@code true} if new tasks can be scheduled.
+ * @return {@code true} if new tasks can be scheduled
*/
private boolean canSchedule() {
return !shutdown && (masterController == null || masterController.canSchedule());
@@ -236,18 +235,18 @@ protected ShutdownResult describeStopped(boolean stopNow) {
/**
* Stop/Shutdown/Interrupt scheduler and its children (if any).
*
- * @param executedTests Started tests which have finished normally or abruptly till called this method.
- * @param incompleteTests Started tests which have finished incomplete due to shutdown.
- * @param tryCancelFutures Useful to set to {@code false} if a timeout is specified in plugin config.
+ * @param executedTests started tests which have finished normally or abruptly till called this method
+ * @param incompleteTests started tests which have finished incomplete due to shutdown
+ * @param tryCancelFutures useful to set to {@code false} if a timeout is specified in plugin config.
* When the runner of
* {@link ParallelComputer#getSuite(org.junit.runners.model.RunnerBuilder, Class[])}
* is finished in
* {@link org.junit.runners.Suite#run(org.junit.runner.notification.RunNotifier)}
* all the thread-pools created by {@link ParallelComputerBuilder.PC} are already dead.
* See the unit test {@code ParallelComputerBuilder#timeoutAndForcedShutdown()}.
- * @param stopNow Interrupting tests by {@link java.util.concurrent.ExecutorService#shutdownNow()} or
+ * @param stopNow interrupting tests by {@link java.util.concurrent.ExecutorService#shutdownNow()} or
* {@link java.util.concurrent.Future#cancel(boolean) Future#cancel(true)} or
- * {@link Thread#interrupt()}.
+ * {@link Thread#interrupt()}
*/
private void stop(
Collection<Description> executedTests,
@@ -369,7 +368,7 @@ private Controller(Scheduler slave) {
}
/**
- * @return {@code true} if new children can be scheduled.
+ * @return {@code true} if new children can be scheduled
*/
boolean canSchedule() {
return Scheduler.this.canSchedule();
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/SchedulingStrategy.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/SchedulingStrategy.java
index 7495464..b4639c0 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/SchedulingStrategy.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/SchedulingStrategy.java
@@ -62,7 +62,7 @@ protected SchedulingStrategy(ConsoleLogger logger) {
*
* @return {@code true} if successfully stopped the scheduler, else
* {@code false} if already stopped (a <b>shared</b> thread
- * pool was shutdown externally).
+ * pool was shutdown externally)
* @throws InterruptedException if interrupted while waiting
* for scheduled tasks to finish
* @see org.junit.runners.model.RunnerScheduler#finished()
@@ -75,7 +75,7 @@ protected SchedulingStrategy(ConsoleLogger logger) {
*
* @return {@code true} if successfully stopped the scheduler, else
* {@code false} if already stopped (a <b>shared</b> thread
- * pool was shutdown externally).
+ * pool was shutdown externally)
* @see java.util.concurrent.ExecutorService#shutdown()
*/
protected abstract boolean stop();
@@ -89,7 +89,7 @@ protected SchedulingStrategy(ConsoleLogger logger) {
*
* @return {@code true} if successfully stopped the scheduler, else
* {@code false} if already stopped (a <b>shared</b> thread
- * pool was shutdown externally).
+ * pool was shutdown externally)
* @see java.util.concurrent.ExecutorService#shutdownNow()
*/
protected boolean stopNow() {
@@ -99,7 +99,8 @@ protected boolean stopNow() {
/**
* Persistently disables this strategy. Atomically ignores {@link Balancer} to acquire a new permit.<br>
* The method {@link #canSchedule()} atomically returns {@code false}.
- * @return {@code true} if {@link #canSchedule()} has return {@code true} on the beginning of this method call.
+ *
+ * @return {@code true} if {@link #canSchedule()} has return {@code true} on the beginning of this method call
*/
protected boolean disable() {
return canSchedule.getAndSet(false);
@@ -109,12 +110,12 @@ protected void setDefaultShutdownHandler(Scheduler.ShutdownHandler handler) {}
/**
* @return {@code true} if a thread pool associated with this strategy
- * can be shared with other strategies.
+ * can be shared with other strategies
*/
protected abstract boolean hasSharedThreadPool();
/**
- * @return {@code true} unless stopped, finished or disabled.
+ * @return {@code true} unless stopped, finished or disabled
*/
protected boolean canSchedule() {
return canSchedule.get();
diff --git a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ThreadResourcesBalancer.java b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ThreadResourcesBalancer.java
index 5bb47dd..4f8dd73 100644
--- a/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ThreadResourcesBalancer.java
+++ b/surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ThreadResourcesBalancer.java
@@ -59,7 +59,7 @@ final class ThreadResourcesBalancer implements Balancer {
* Acquires a permit from this balancer, blocking until one is available.
*
* @return {@code true} if current thread is <b>NOT</b> interrupted
- * while waiting for a permit.
+ * while waiting for a permit
*/
@Override
public boolean acquirePermit() {
diff --git a/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/GroupMatcherMethodSelector.java b/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/GroupMatcherMethodSelector.java
index fa8d02e..abfd24b 100644
--- a/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/GroupMatcherMethodSelector.java
+++ b/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/GroupMatcherMethodSelector.java
@@ -33,7 +33,6 @@
/**
* Method selector delegating to {@link GroupMatcher} to decide if a method is included or not.
- *
*/
public class GroupMatcherMethodSelector implements IMethodSelector {
diff --git a/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/MethodSelector.java b/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/MethodSelector.java
index b5930ad..368159d 100644
--- a/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/MethodSelector.java
+++ b/surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/MethodSelector.java
@@ -26,7 +26,7 @@
import org.testng.ITestNGMethod;
/**
- * For internal use only
+ * For internal use only.
*
* @author Olivier Lamy
* @since 2.7.3
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/ConfigurationAwareTestNGReporter.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/ConfigurationAwareTestNGReporter.java
index 71637ab..4ac3c9e 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/ConfigurationAwareTestNGReporter.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/ConfigurationAwareTestNGReporter.java
@@ -23,7 +23,7 @@
import org.testng.internal.IResultListener;
/**
- * Just like TestNGReporter, but explicitly implements IResultListener; this interface is new in TestNG 5.5
+ * Just like TestNGReporter, but explicitly implements IResultListener; this interface is new in TestNG 5.5.
*
* @author Dan Fabulich
*/
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGExecutor.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGExecutor.java
index 816e564..8813436 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGExecutor.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGExecutor.java
@@ -64,10 +64,10 @@
* @author <a href='mailto:the[dot]mindstorm[at]gmail[dot]com'>Alex Popescu</a>
*/
final class TestNGExecutor {
- /** The default name for a suite launched from the maven surefire plugin */
+ /** The default name for a suite launched from the maven surefire plugin. */
private static final String DEFAULT_SUREFIRE_SUITE_NAME = "Surefire suite";
- /** The default name for a test launched from the maven surefire plugin */
+ /** The default name for a test launched from the maven surefire plugin. */
private static final String DEFAULT_SUREFIRE_TEST_NAME = "Surefire test";
private static final boolean HAS_TEST_ANNOTATION_ON_CLASSPATH =
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
index ec887b7..1f9f991 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java
@@ -64,7 +64,7 @@ public class TestNGReporter
* method call has already associated with this instance <i>before</i> the test
* suite is run.
*
- * @param reportManager Instance to report suite status to
+ * @param reportManager instance to report suite status to
*/
public TestNGReporter(TestReportListener<TestOutputReportEntry> reportManager) {
this.reporter = reportManager;
@@ -146,8 +146,8 @@ public void onFinish(ISuite suite) {}
* Creates a string out of the list of testng groups in the
* form of <pre>"group1,group2,group3"</pre>.
*
- * @param groups The groups being run
- * @param defaultValue The default to use if no groups
+ * @param groups the groups being run
+ * @param defaultValue the default to use if no groups
* @return a string describing the groups
*/
private static String groupString(String[] groups, String defaultValue) {
@@ -182,7 +182,7 @@ public void onConfigurationSuccess(ITestResult result) {
/**
* Acquire a better representation of the test name that includes parameters and the invocation count, if there are
- * any parameters
+ * any parameters.
*
* @param result the test result to extract from
* @return a descriptive name for the test
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/AbstractDirectConfigurator.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/AbstractDirectConfigurator.java
index b73b9ba..508993b 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/AbstractDirectConfigurator.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/AbstractDirectConfigurator.java
@@ -30,8 +30,7 @@
import org.testng.xml.XmlSuite;
/**
- * Configurator that relies on reflection to set parameters in TestNG
- *
+ * Configurator that relies on reflection to set parameters in TestNG.
*/
public abstract class AbstractDirectConfigurator implements Configurator {
final Map<String, Setter> setters;
@@ -118,8 +117,7 @@ static Class<?> loadClass(String className) throws TestSetFailedException {
}
/**
- * Describes a property setter by method name and parameter class
- *
+ * Describes a property setter by method name and parameter class.
*/
public static final class Setter {
private final String setterName;
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/Configurator.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/Configurator.java
index c24bf1b..b674b65 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/Configurator.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/Configurator.java
@@ -25,8 +25,7 @@
import org.testng.xml.XmlSuite;
/**
- * Configurator for passing configuration properties to TestNG
- *
+ * Configurator for passing configuration properties to TestNG.
*/
public interface Configurator {
void configure(TestNG testng, Map<String, String> options) throws TestSetFailedException;
diff --git a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java
index 3f1b077..7bf16a1 100644
--- a/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java
+++ b/surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java
@@ -43,7 +43,7 @@ public class TestNG740Configurator extends TestNG60Configurator {
* Surefire plugin configuration to its corresponding constant and applies this to the specified suite object.
*
* @param suite TestNG {@link XmlSuite} object
- * @param options Surefire plugin configuration options
+ * @param options surefire plugin configuration options
* @throws TestSetFailedException if unable to convert specified [parallel] setting
*/
@Override
diff --git a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestCase.java b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestCase.java
index c62e89b..bbe7f6a 100644
--- a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestCase.java
+++ b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestCase.java
@@ -24,9 +24,6 @@
import static org.apache.maven.shared.utils.StringUtils.isNotBlank;
-/**
- *
- */
public final class ReportTestCase {
private String fullClassName;
diff --git a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestSuite.java b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestSuite.java
index 6e42cb4..deb33e1 100644
--- a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestSuite.java
+++ b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestSuite.java
@@ -21,9 +21,6 @@
import java.util.ArrayList;
import java.util.List;
-/**
- *
- */
public final class ReportTestSuite {
private final List<ReportTestCase> testCases = new ArrayList<>();
diff --git a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportParser.java b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportParser.java
index 2303176..522bd3b 100644
--- a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportParser.java
+++ b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportParser.java
@@ -34,9 +34,6 @@
import static org.apache.maven.shared.utils.StringUtils.split;
-/**
- *
- */
public final class SurefireReportParser {
private static final String INCLUDES = "*.xml";
@@ -166,7 +163,7 @@ public List<ReportTestCase> getFailureDetails(List<ReportTestSuite> testSuites)
* Returns {@code true} if the specified directory contains at least one report file.
*
* @param directory the directory
- * @return {@code true} if the specified directory contains at least one report file.
+ * @return {@code true} if the specified directory contains at least one report file
*/
public static boolean hasReportFiles(File directory) {
return directory != null
diff --git a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java
index c0643fd..6ef0c31 100644
--- a/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java
+++ b/surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java
@@ -40,9 +40,6 @@
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.apache.maven.shared.utils.StringUtils.isBlank;
-/**
- *
- */
public final class TestSuiteXmlParser extends DefaultHandler {
private final ConsoleLogger consoleLogger;
