You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2025/08/15 12:22:58 UTC

(maven-archiver) 01/01: Follow Oracle javadoc guidelines

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

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

commit 3b7c82e785e9d32204a4ee8b2c3927fc8745bfd5
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Fri Aug 15 08:22:43 2025 -0400

    Follow Oracle javadoc guidelines
---
 .../java/org/apache/maven/shared/archiver/MavenArchiver.java | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java b/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
index 550831d..6474159 100644
--- a/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
+++ b/src/main/java/org/apache/maven/shared/archiver/MavenArchiver.java
@@ -85,7 +85,7 @@ public class MavenArchiver {
                     + "${artifact.version}${dashClassifier?}.${artifact.extension}";
 
     /**
-     * simple layout non unique.
+     * Simple layout non unique.
      */
     public static final String SIMPLE_LAYOUT_NONUNIQUE =
             "${artifact.artifactId}-${artifact.baseVersion}${dashClassifier?}.${artifact.extension}";
@@ -190,7 +190,7 @@ public class MavenArchiver {
      * @param project {@link org.apache.maven.api.Project}
      * @param config  {@link ManifestConfiguration}
      * @return {@link org.codehaus.plexus.archiver.jar.Manifest}
-     * @throws MavenArchiverException exception.
+     * @throws MavenArchiverException exception
      */
     // TODO Add user attributes list and user groups list
     public Manifest getManifest(Project project, ManifestConfiguration config) throws MavenArchiverException {
@@ -228,7 +228,7 @@ public class MavenArchiver {
      * @param session {@link org.apache.maven.api.Session}
      * @param project {@link org.apache.maven.api.Project}
      * @param config  {@link ManifestConfiguration}
-     * @param entries The entries.
+     * @param entries the entries
      * @return {@link org.codehaus.plexus.archiver.jar.Manifest}
      * @throws MavenArchiverException exception
      */
@@ -476,7 +476,7 @@ public class MavenArchiver {
     /**
      * <p>setOutputFile.</p>
      *
-     * @param outputFile Set output file.
+     * @param outputFile set output file
      */
     public void setOutputFile(File outputFile) {
         archiveFile = outputFile;
@@ -488,7 +488,7 @@ public class MavenArchiver {
      * @param session              {@link org.apache.maven.api.Session}
      * @param project              {@link org.apache.maven.api.Project}
      * @param archiveConfiguration {@link MavenArchiveConfiguration}
-     * @throws MavenArchiverException Archiver Exception.
+     * @throws MavenArchiverException archiver Exception
      */
     public void createArchive(Session session, Project project, MavenArchiveConfiguration archiveConfiguration)
             throws MavenArchiverException {
@@ -679,7 +679,7 @@ public class MavenArchiver {
      * @throws IllegalArgumentException if the outputTimestamp is neither ISO 8601 nor an integer, or it's not within
      *             the valid range 1980-01-01T00:00:02Z to 2099-12-31T23:59:59Z as defined by
      *             <a href="https://pkwaredownloads.blob.core.windows.net/pem/APPNOTE.txt">ZIP application note</a>,
-     *             section 4.4.6.
+     *             section 4.4.6
      * @see <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=74682318">Maven Wiki "Reproducible/Verifiable
      *      Builds"</a>
      */