[jackrabbit-filevault-package-maven-plugin] branch master updated: trivial: streamline javadoc of Mojos

[kw...@apache.org]

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

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault-package-maven-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 9db9dbc  trivial: streamline javadoc of Mojos
9db9dbc is described below

commit 9db9dbc03ea59ccbb44876a57f601790d5857922
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Jun 2 11:18:25 2021 +0200

    trivial: streamline javadoc of Mojos
---
 .../jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java  | 2 +-
 .../jackrabbit/filevault/maven/packaging/CheckSignatureMojo.java  | 4 ++--
 .../filevault/maven/packaging/FormatDocviewXmlMojo.java           | 2 +-
 .../filevault/maven/packaging/GenerateMetadataMojo.java           | 8 ++++----
 .../jackrabbit/filevault/maven/packaging/ValidateFilesMojo.java   | 2 +-
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java
index 385b7f5..a1bfa0b 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AnalyzeClassesMojo.java
@@ -36,7 +36,7 @@ import org.apache.maven.shared.artifact.filter.PatternExcludesArtifactFilter;
 import aQute.bnd.osgi.Processor;
 
 /**
- * Maven goal which analyzes the generated class files and generates a usage report
+ * Analyzes the generated class files and generates a usage report
  */
 @Mojo(
         name = "analyze-classes",
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CheckSignatureMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CheckSignatureMojo.java
index f85533a..e3d4583 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CheckSignatureMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/CheckSignatureMojo.java
@@ -46,8 +46,8 @@ import org.eclipse.aether.artifact.DefaultArtifact;
 import org.eclipse.aether.repository.RemoteRepository;
 
 /**
- * Maven goal which checks the embedded libraries against a defined
- * signature. Based on the Animal Sniffer project.
+ * Checks the embedded libraries against a defined
+ * signature. Based on the <a href="https://www.mojohaus.org/animal-sniffer/">Animal Sniffer project</a>.
  */
 @Mojo(
         name = "check-signature",
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/FormatDocviewXmlMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/FormatDocviewXmlMojo.java
index dec8fd6..692222e 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/FormatDocviewXmlMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/FormatDocviewXmlMojo.java
@@ -39,7 +39,7 @@ import org.jetbrains.annotations.NotNull;
 import org.sonatype.plexus.build.incremental.BuildContext;
 
 /**
- * Maven goal which either checks only the formatting of the Docview XML files to comply with the 
+ * Either checks only the formatting of the Docview XML files to comply with the 
  * formatting rules from FileVault or also reformats those files.
  */
 @Mojo(
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
index 2256887..700368d 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/GenerateMetadataMojo.java
@@ -49,6 +49,7 @@ import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
 import org.apache.commons.io.FilenameUtils;
+import org.apache.jackrabbit.util.Text;
 import org.apache.jackrabbit.vault.fs.api.PathFilterSet;
 import org.apache.jackrabbit.vault.fs.api.WorkspaceFilter;
 import org.apache.jackrabbit.vault.fs.config.ConfigurationException;
@@ -60,7 +61,6 @@ import org.apache.jackrabbit.vault.packaging.PackageId;
 import org.apache.jackrabbit.vault.packaging.PackageProperties;
 import org.apache.jackrabbit.vault.packaging.PackageType;
 import org.apache.jackrabbit.vault.util.Constants;
-import org.apache.jackrabbit.vault.util.Text;
 import org.apache.maven.archiver.ManifestConfiguration;
 import org.apache.maven.archiver.MavenArchiveConfiguration;
 import org.apache.maven.archiver.MavenArchiver;
@@ -77,10 +77,10 @@ import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.archiver.jar.ManifestException;
+import org.apache.maven.shared.utils.StringUtils;
 import org.apache.maven.shared.utils.io.FileUtils;
 import org.apache.maven.shared.utils.io.IOUtil;
-import org.apache.maven.shared.utils.StringUtils;
+import org.codehaus.plexus.archiver.jar.ManifestException;
 import org.eclipse.aether.RepositorySystem;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.repository.RemoteRepository;
@@ -91,7 +91,7 @@ import aQute.bnd.header.Parameters;
 import aQute.bnd.osgi.Processor;
 
 /**
- * Maven goal which generates the metadata ending up in the package like {@code META-INF/MANIFEST.MF} as well as the
+ * Generates the metadata ending up in the package like {@code META-INF/MANIFEST.MF} as well as the
  * files ending up in {@code META-INF/vault} like {@code filter.xml}, {@code properties.xml}, {@code config.xml} and
  * {@code settings.xml}. Those files will be written to the directory given via parameter {@link #workDirectory}.
  * In addition performs some validations.
diff --git a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidateFilesMojo.java b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidateFilesMojo.java
index 995602f..3b12903 100644
--- a/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidateFilesMojo.java
+++ b/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/ValidateFilesMojo.java
@@ -60,7 +60,7 @@ import org.codehaus.plexus.util.Scanner;
 
 /** 
  * Validates individual files with all registered validators. This is only active for incremental builds (i.e. inside m2e)
- * or when mojo "validate-package" is not executed in the current Maven execution
+ * or when mojo "validate-package" is not executed in the current Maven execution.
  * @see <a href="https://jackrabbit.apache.org/filevault-package-maven-plugin/validators.html">Validators</a>
  */
 @Mojo(name = "validate-files", defaultPhase = LifecyclePhase.PROCESS_CLASSES, requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = true)