(maven-pmd-plugin) branch master updated: Clean up some Javadoc comments (#219)

[el...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 0c337aa  Clean up some Javadoc comments (#219)
0c337aa is described below

commit 0c337aa346d1d59c964b234322b6168525e2aca0
Author: Elliotte Rusty Harold <el...@users.noreply.github.com>
AuthorDate: Sat Jun 7 11:38:22 2025 +0000

    Clean up some Javadoc comments (#219)
---
 .../org/apache/maven/plugins/pmd/AbstractPmdReport.java     |  9 ++++-----
 .../maven/plugins/pmd/AbstractPmdViolationCheckMojo.java    | 13 +------------
 .../java/org/apache/maven/plugins/pmd/exec/PmdExecutor.java |  3 ---
 3 files changed, 5 insertions(+), 20 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java
index 3176dad..2b680ee 100644
--- a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java
+++ b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdReport.java
@@ -273,11 +273,11 @@ public abstract class AbstractPmdReport extends AbstractMavenReport {
     }
 
     /**
-     * Convenience method to get the list of files where the PMD tool will be executed
+     * Convenience method to retrieve the files on which the PMD tool will be executed.
      *
-     * @return a List of the files where the PMD tool will be executed
-     * @throws IOException If an I/O error occurs during construction of the
-     *                     canonical pathnames of the files
+     * @return a map of the files where the PMD tool will be executed
+     * @throws IOException if an I/O error occurs during construction of the
+     *                     canonical paths of the files
      */
     protected Map<File, PmdFileInfo> getFilesToProcess() throws IOException {
         if (aggregate && !project.isExecutionRoot()) {
@@ -481,7 +481,6 @@ public abstract class AbstractPmdReport extends AbstractMavenReport {
      *
      * @param aggregatedProject the project being aggregated
      * @param reactorProjectsMap map of (still) available reactor projects
-     * @throws MavenReportException if any
      */
     private Set<MavenProject> modulesForAggregatedProject(
             MavenProject aggregatedProject, Map<Path, MavenProject> reactorProjectsMap) {
diff --git a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.java b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.java
index ddd794a..0f16e5e 100644
--- a/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.java
+++ b/src/main/java/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.java
@@ -175,11 +175,7 @@ public abstract class AbstractPmdViolationCheckMojo<D> extends AbstractMojo {
     /**
      * Method for collecting the violations found by the PMD tool
      *
-     * @param analysisFile
-     * @param failurePriority
      * @return an int that specifies the number of violations found
-     * @throws XmlPullParserException
-     * @throws IOException
      */
     private ViolationDetails<D> getViolations(final File analysisFile, final int failurePriority)
             throws XmlPullParserException, IOException {
@@ -227,14 +223,7 @@ public abstract class AbstractPmdViolationCheckMojo<D> extends AbstractMojo {
     }
 
     /**
-     * Gets the output message
-     *
-     * @param failureCount
-     * @param warningCount
-     * @param analyzerName
-     * @param failureName
-     * @param outputFile
-     * @return
+     * Gets the output message.
      */
     private String getMessage(
             final int failureCount,
diff --git a/src/main/java/org/apache/maven/plugins/pmd/exec/PmdExecutor.java b/src/main/java/org/apache/maven/plugins/pmd/exec/PmdExecutor.java
index 0fcb502..c9b1b6f 100644
--- a/src/main/java/org/apache/maven/plugins/pmd/exec/PmdExecutor.java
+++ b/src/main/java/org/apache/maven/plugins/pmd/exec/PmdExecutor.java
@@ -352,9 +352,6 @@ public class PmdExecutor extends Executor {
 
     /**
      * Use the PMD renderers to render in any format aside from HTML and XML.
-     *
-     * @param report
-     * @throws MavenReportException
      */
     private void writeFormattedReport(Report report) throws IOException, MavenReportException {
         Renderer renderer = createRenderer(request.getFormat(), request.getOutputEncoding());