Follow Oracle javadoc guidelines

[elharo]

No description provided.

[Copilot]

Pull Request Overview

This PR follows Oracle javadoc guidelines by removing empty javadoc blocks, improving period usage in comments, and fixing capitalization inconsistencies. The changes focus on code documentation quality without altering functionality.

• Removes empty javadoc blocks that provide no value (/**\n*\n*/)
• Adds periods to end javadoc descriptions where missing
• Fixes capitalization inconsistencies in javadoc comments

Reviewed Changes

Copilot reviewed 160 out of 160 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/TestSuiteXmlParser.java	Removes empty javadoc block before class declaration
surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportParser.java	Removes empty javadoc block and fixes period in @return tag
surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestSuite.java	Removes empty javadoc block
surefire-report-parser/src/main/java/org/apache/maven/plugins/surefire/report/ReportTestCase.java	Removes empty javadoc block
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/TestNG740Configurator.java	Capitalizes "surefire" to "Surefire" in parameter description
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/Configurator.java	Adds period to javadoc description
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/conf/AbstractDirectConfigurator.java	Adds periods to javadoc descriptions
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGReporter.java	Capitalizes parameter descriptions and adds period
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/TestNGExecutor.java	Adds periods to javadoc comments
surefire-providers/surefire-testng/src/main/java/org/apache/maven/surefire/testng/ConfigurationAwareTestNGReporter.java	Adds period to javadoc description
surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/MethodSelector.java	Adds period to javadoc description
surefire-providers/surefire-testng-utils/src/main/java/org/apache/maven/surefire/testng/utils/GroupMatcherMethodSelector.java	Removes empty line in javadoc
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ThreadResourcesBalancer.java	Removes period from @return tag
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/SchedulingStrategy.java	Updates multiple javadoc comments to remove periods from @return tags and add periods to descriptions
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Scheduler.java	Updates parameter descriptions and @return tags
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/ParallelComputerBuilder.java	Capitalizes parameter description and fixes @throws tag
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/BalancerFactory.java	Adds blank line and capitalizes @return description
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/pc/Balancer.java	Removes period from @return tag
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/TestMethod.java	Adds period to javadoc description
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/LogicalStream.java	Adds period to javadoc description
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreWrapper.java	Adds period to javadoc description
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreRunListener.java	Capitalizes parameter description
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCoreParameters.java	Reorganizes @deprecated and @return tags
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/JUnitCore.java	Reorganizes @SInCE and @see tags
surefire-providers/surefire-junit47/src/main/java/org/apache/maven/surefire/junitcore/ConcurrentRunListener.java	Adds period and reorganizes @author and @see tags
surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/TestListenerInvocationHandler.java	Removes empty line in javadoc
surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/SurefireTestSetExecutor.java	Adds period to javadoc description
surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/PojoTestSetExecutor.java	Adds period to javadoc description
surefire-providers/surefire-junit3/src/main/java/org/apache/maven/surefire/junit/JUnitTestSetExecutor.java	Adds period to javadoc description
surefire-providers/surefire-junit-platform/src/main/java/org/apache/maven/surefire/junitplatform/RunListenerAdapter.java	Adds periods to javadoc descriptions
surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/JUnit48TestChecker.java	Adds period and blank line to javadoc
surefire-providers/common-junit48/src/main/java/org/apache/maven/surefire/common/junit48/FilterFactory.java	Removes period from @return tag
surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnitTestFailureListener.java	Adds period to javadoc description
surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4RunListener.java	Adds period to javadoc description
surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4Reflector.java	Adds period to javadoc description
surefire-providers/common-junit4/src/main/java/org/apache/maven/surefire/common/junit4/JUnit4ProviderUtil.java	Removes empty lines and adds periods to javadoc
surefire-providers/common-junit3/src/main/java/org/apache/maven/surefire/common/junit3/JUnit3Reflector.java	Adds period to javadoc description
surefire-providers/common-java5/src/main/java/org/apache/maven/surefire/report/NullStackTraceFilter.java	Capitalizes and adds period to javadoc description
surefire-logger-api/src/main/java/org/apache/maven/plugin/surefire/log/api/Level.java	Capitalizes and adds periods to javadoc descriptions
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/SingleGroupMatcher.java	Adds period to javadoc description
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/OrGroupMatcher.java	Adds period to javadoc description
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/JoinGroupMatcher.java	Adds period to javadoc description
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/InverseGroupMatcher.java	Adds period to javadoc description
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/GroupMatcher.java	Adds period to javadoc description
surefire-grouper/src/main/java/org/apache/maven/surefire/group/match/AndGroupMatcher.java	Adds period to javadoc description
surefire-extensions-spi/src/main/java/org/apache/maven/surefire/spi/MasterProcessChannelProcessorFactory.java	Adds blank lines to javadoc sections
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/LineConsumerThread.java	Removes empty javadoc block
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineStreams.java	Removes empty javadoc block
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/util/CommandlineExecutor.java	Properly formats {@inheritdoc} javadoc
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoReporter.java	Reorganizes @SInCE and parameter tags
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoFileReportEventListener.java	Reorganizes @SInCE and parameter tags
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessTestsetInfoConsoleReportEventListener.java	Reorganizes @SInCE and parameter tags
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReporter.java	Reorganizes @SInCE tag and adds period
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/StatelessReportEventListener.java	Adds blank line and reorganizes @SInCE tag
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ForkChannel.java	Reorganizes @throws tags and capitalizes description
surefire-extensions-api/src/main/java/org/apache/maven/surefire/extensions/ConsoleOutputReporter.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/EventEncoder.java	Removes empty javadoc block
surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java	Removes empty javadoc block
surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/EventChannelEncoder.java	Capitalizes javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java	Capitalizes javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemUtils.java	Removes period from @return tag and adds period to description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/SystemPropertyManager.java	Capitalizes parameter descriptions and adds periods
surefire-booter/src/main/java/org/apache/maven/surefire/booter/SurefireReflector.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/PropertiesWrapper.java	Capitalizes parameter descriptions and adds period
surefire-booter/src/main/java/org/apache/maven/surefire/booter/ProcessCheckerType.java	Removes empty javadoc block
surefire-booter/src/main/java/org/apache/maven/surefire/booter/PpidChecker.java	Capitalizes @return description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/ModularClasspathConfiguration.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/LazyTestsToRun.java	Adds period, blank line, and removes period from @return tags
surefire-booter/src/main/java/org/apache/maven/surefire/booter/KeyValueSource.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/IsolatedClassLoader.java	Removes period from @deprecated tag
surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedNodeArg.java	Removes empty javadoc block
surefire-booter/src/main/java/org/apache/maven/surefire/booter/ForkedBooter.java	Capitalizes parameter descriptions
surefire-booter/src/main/java/org/apache/maven/surefire/booter/CommandReader.java	Removes periods from @return tags
surefire-booter/src/main/java/org/apache/maven/surefire/booter/ClasspathConfiguration.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/Classpath.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterDeserializer.java	Removes period from @return tag
surefire-booter/src/main/java/org/apache/maven/surefire/booter/BooterConstants.java	Adds period to javadoc description
surefire-booter/src/main/java/org/apache/maven/surefire/booter/AbstractPathConfiguration.java	Removes periods from @return tags
surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/StringUtils.java	Capitalizes parameter description and removes period from @return tag
surefire-api/src/main/java/org/apache/maven/surefire/api/util/internal/DaemonThreadFactory.java	Adds blank line to javadoc
surefire-api/src/main/java/org/apache/maven/surefire/api/util/TestsToRun.java	Adds periods and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/util/TempFileManager.java	Adds blank line to javadoc
surefire-api/src/main/java/org/apache/maven/surefire/api/util/SurefireReflectionException.java	Capitalizes parameter description
surefire-api/src/main/java/org/apache/maven/surefire/api/util/ScannerFilter.java	Adds period and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/util/RunOrder.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/util/DirectoryScanner.java	Adds periods and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/util/DefaultRunOrderCalculator.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/util/CloseableIterator.java	Reorganizes parameter and author tags
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestSetFailedException.java	Capitalizes parameter descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestRequest.java	Adds periods and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestListResolver.java	Removes empty line and removes period from @return tag
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/TestArtifactInfo.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/ResolvedTest.java	Adds blank line and periods to descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/testset/DirectoryScannerParameters.java	Capitalizes @return descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/stream/SegmentType.java	Removes empty javadoc block
surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java	Removes empty javadoc block
surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamEncoder.java	Adds blank line to javadoc
surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java	Removes empty javadoc blocks and adds periods
surefire-api/src/main/java/org/apache/maven/surefire/api/runorder/Priority.java	Capitalizes parameter descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReportEntry.java	Capitalizes parameter descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/report/TestOutputReceiver.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/report/SafeThrowable.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/report/RunListener.java	Adds periods and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactoryOptions.java	Capitalizes javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterFactory.java	Capitalizes @return description
surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReporterConfiguration.java	Adds period and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/report/ReportEntry.java	Adds periods and capitalizes descriptions
surefire-api/src/main/java/org/apache/maven/surefire/api/provider/SurefireProvider.java	Capitalizes descriptions and reorganizes @throws tags
surefire-api/src/main/java/org/apache/maven/surefire/api/provider/ProviderParameters.java	Adds periods, capitalizes descriptions, and updates @deprecated tags
surefire-api/src/main/java/org/apache/maven/surefire/api/provider/AbstractProvider.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/filter/SpecificTestClassFilter.java	Adds period to javadoc description
surefire-api/src/main/java/org/apache/maven/surefire/api/event/AbstractTestControlEvent.java	Reorganizes @SInCE and parameter tags
surefire-api/src/main/java/org/apache/maven/surefire/api/cli/CommandLineOption.java	Reorganizes @SInCE and @see tags
surefire-api/src/main/java/org/apache/maven/surefire/api/booter/Constants.java	Removes empty javadoc block
surefire-api/src/main/java/org/apache/maven/surefire/api/booter/BiProperty.java	Reorganizes @SInCE and parameter tags
maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReportRenderer.java	Capitalizes parameter descriptions
maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/SurefireReport.java	Adds blank lines to javadoc
maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/PluginConsoleLogger.java	Reorganizes @SInCE and @see tags
maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/FailsafeOnlyReport.java	Adds blank lines to javadoc
maven-surefire-report-plugin/src/main/java/org/apache/maven/plugins/surefire/report/AbstractSurefireReport.java	Capitalizes descriptions and properly formats {@inheritdoc} tags
maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java	Removes empty javadoc block
maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/CommandEncoder.java	Removes empty javadoc block
maven-surefire-common/src/main/java/org/apache/maven/surefire/providerapi/ServiceLoader.java	Capitalizes parameter descriptions
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/SpecificFileFilter.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/Relocator.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/util/DependencyScanner.java	Removes empty line from javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetRunListener.java	Capitalizes javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestMethodStats.java	Removes empty lines from javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java	Capitalizes parameter descriptions and adds periods
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/ReportEntryType.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/FileReporterUtils.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/DefaultReporterFactory.java	Adds periods to javadoc descriptions
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/log/PluginConsoleLogger.java	Reorganizes @SInCE and @see tags
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5Xml30StatelessReporter.java	Adds blank line to javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/junit5/JUnit5ConsoleOutputReporter.java	Adds blank line to javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/SurefireStatelessReporter.java	Adds blank lines to javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java	Removes empty javadoc block
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ThreadedStreamConsumer.java	Removes empty javadoc block
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/NativeStdErrStreamConsumer.java	Reorganizes @SInCE and @see tags
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessReportEventListener.java	Reorganizes @SInCE and parameter tags
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkedProcessEventNotifier.java	Capitalizes javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/ForkClient.java	Capitalizes @return description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/output/DeserializedStacktraceWriter.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestProvidingInputStream.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/TestLessInputStream.java	Removes period from @return tag
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/NotifiableTestStream.java	Reorganizes @SInCE and @see tags
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/DefaultCommandReader.java	Adds blank line and reorganizes @SInCE tag
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/lazytestprovider/Commandline.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/JarManifestForkConfiguration.java	Capitalizes parameter descriptions
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkStarter.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkNumberBucket.java	Adds periods and removes periods from parameter descriptions
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/ForkConfiguration.java	Capitalizes parameter description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/DefaultForkConfiguration.java	Capitalizes parameter description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/booterclient/BooterSerializer.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireProperties.java	Adds periods and blank lines to javadoc
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireHelper.java	Adds periods to javadoc descriptions
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/SurefireExecutionParameters.java	Adds period to javadoc description
maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java	Updates @deprecated tags, adds blank lines, removes empty javadoc, and capitalizes descriptions
maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/VerifyMojo.java	Updates @deprecated tag and adds blank line
maven-failsafe-plugin/src/main/java/org/apache/maven/plugin/failsafe/IntegrationTestMojo.java	Updates @deprecated tag and capitalizes @return description

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[olamy]

please hold on for those cosmetic changes as I have a lot changes coming with #3179

[Bukama]

As in all other "follow Oracle javadoc guidelines" this is PR is not about fully following, but only some formatting. Same as in other PR there are a missing method/parameter descriptions, so the title/commit message should be renamed to formatting and grammar fixes or so.