(maven-changes-plugin) branch master updated: Minor doc fixes (#112)

[elharo]

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-changes-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 0096f7a  Minor doc fixes (#112)
0096f7a is described below

commit 0096f7ae677abe8975b0cd59237a74a4ee754663
Author: Elliotte Rusty Harold <elh...@users.noreply.github.com>
AuthorDate: Mon Mar 24 14:04:02 2025 +0000

    Minor doc fixes (#112)
    
    * Minor doc fixes
    
    * spotless
---
 .../org/apache/maven/plugins/changes/ChangesReport.java     |  2 +-
 .../apache/maven/plugins/changes/ChangesValidatorMojo.java  | 13 ++++++-------
 2 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java 
b/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
index ba98d6b..6531dd4 100644
--- a/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
+++ b/src/main/java/org/apache/maven/plugins/changes/ChangesReport.java
@@ -84,7 +84,7 @@ public class ChangesReport extends AbstractChangesReport {
     private File filteredOutputDirectory;
 
     /**
-     * applying filtering filtering "a la" resources plugin
+     * apply filtering "a la" resources plugin
      *
      * @since 2.2
      */
diff --git 
a/src/main/java/org/apache/maven/plugins/changes/ChangesValidatorMojo.java 
b/src/main/java/org/apache/maven/plugins/changes/ChangesValidatorMojo.java
index cb2849c..df448f0 100644
--- a/src/main/java/org/apache/maven/plugins/changes/ChangesValidatorMojo.java
+++ b/src/main/java/org/apache/maven/plugins/changes/ChangesValidatorMojo.java
@@ -32,7 +32,7 @@ import 
org.apache.maven.plugins.changes.schema.XmlValidationHandler;
 import org.xml.sax.SAXParseException;
 
 /**
- * Goal which validate the <code>changes.xml</code> file.
+ * Goal which validates the <code>changes.xml</code> file.
  *
  * @author Olivier Lamy
  * @version $Id$
@@ -48,13 +48,13 @@ public class ChangesValidatorMojo extends 
AbstractChangesMojo {
     private String changesXsdVersion;
 
     /**
-     * Mojo failure if validation failed. If not and validation failed, only a 
warning will be logged.
+     * Mojo failure if validation failed. If false and validation failed, only 
a warning will be logged.
      */
     @Parameter(property = "changes.validate.failed", defaultValue = "false")
     private boolean failOnError;
 
     /**
-     * The path of the <code>changes.xml</code> file that will be converted 
into an HTML report.
+     * The path of the <code>changes.xml</code> file that will be validated.
      */
     @Parameter(property = "changes.xmlPath", defaultValue = 
"src/changes/changes.xml")
     private File xmlPath;
@@ -87,7 +87,7 @@ public class ChangesValidatorMojo extends AbstractChangesMojo 
{
                     logSchemaValidation(xmlValidationHandler.getErrors());
                     if (failOnError) {
                         throw new MojoExecutionException("changes.xml file " + 
xmlPath.getAbsolutePath()
-                                + " is not valid, see previous errors.");
+                                + " is not valid. See previous errors.");
                     } else {
                         getLog().info(" skip previous validation errors due to 
failOnError=false.");
                     }
@@ -95,15 +95,14 @@ public class ChangesValidatorMojo extends 
AbstractChangesMojo {
             } catch (SchemaValidatorException e) {
                 if (failOnError) {
                     throw new MojoExecutionException(
-                            "failed to validate changes.xml file " + 
xmlPath.getAbsolutePath() + ": " + e.getMessage(),
-                            e);
+                            "changes.xml file is not valid: " + 
xmlPath.getAbsolutePath() + ": " + e.getMessage(), e);
                 }
             }
         }
     }
 
     private void logSchemaValidation(List<SAXParseException> errors) {
-        getLog().warn("failed to validate changes.xml file " + 
xmlPath.getAbsolutePath());
+        getLog().warn("changes.xml file is not valid: " + 
xmlPath.getAbsolutePath());
         getLog().warn("validation errors: ");
         for (SAXParseException error : errors) {
             getLog().warn(error.getMessage());