Fix Javadoc 8 issues

apache · Dec 28, 2021 · e670d1d · e670d1d
1 parent 0ebd646
commit e670d1d
Show file tree

Hide file tree

Showing 82 changed files with 316 additions and 288 deletions.
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeSet.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeSet.java
@@ -210,9 +210,9 @@ public void addFile( ChangeFile file )
 
     /**
      * @deprecated Use method {@link #containsFilename(String)}
-     * @param filename
+     * @param filename TODO
      * @param repository NOT USED
-     * @return
+     * @return TODO
      */
     public boolean containsFilename( String filename, ScmProviderRepository repository )
     {
@@ -415,7 +415,7 @@ public String getTimeFormatted()
     }
 
     /**
-     * @return
+     * @return TODO
      * @since 1.3
      */
     public String getRevision()
@@ -424,7 +424,7 @@ public String getRevision()
     }
 
     /**
-     * @param revision
+     * @param revision TODO
      * @since 1.3
      */
     public void setRevision( String revision )
@@ -494,7 +494,7 @@ public String toString()
      * Provide the changelog entry as an XML snippet.
      *
      * @return a changelog-entry in xml format
-     * @task make sure comment doesn't contain CDATA tags - MAVEN114
+     * TODO make sure comment doesn't contain CDATA tags - MAVEN114
      */
     public String toXML()
     {
@@ -607,7 +607,7 @@ private String removeCDataEnd( String message )
     /**
      * <p>Escape the <code>toString</code> of the given object.
      * For use in an attribute value.</p>
-     * <p/>
+     * <p>
      * swiped from jakarta-commons/betwixt -- XMLUtils.java
      *
      * @param value escape <code>value.toString()</code>

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java b/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java
@@ -209,6 +209,7 @@ public boolean getBoolean( CommandParameter parameter )
      * @param parameter    The parameter
      * @param defaultValue default value if parameter not exists
      * @return The parameter value as a boolean
+     * @throws ScmException if the parameter doesn't exist
      */
     public boolean getBoolean( CommandParameter parameter, boolean defaultValue )
         throws ScmException

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileStatus.java
@@ -22,13 +22,13 @@
 import java.io.Serializable;
 
 /**
- * @TODO move to a real enum
- * <p/>
+ * TODO move to a real enum
+ * <p>
  * Typesafe enum for file status
  * </p>
- * <p/>
- * There are two types of status defined in this class: <br/>
- * 1) Status: Changes in the working tree, not yet committed to the repository eg. MODIFIED <br/>
+ * <p>
+ * There are two types of status defined in this class: <br>
+ * 1) Status: Changes in the working tree, not yet committed to the repository eg. MODIFIED <br>
  * 2) Transaction: The file is part of some transaction with the repository eg. CHECKED_IN
  * </p>
  *

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmResult.java
@@ -48,7 +48,7 @@ public class ScmResult
 
     /**
      * Copy constructor.
-     * <p/>
+     * <p>
      * Typically used from derived classes when wrapping a ScmResult
      * into a specific type eg. AddScmResult
      *

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/AbstractBranchCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/AbstractBranchCommand.java
@@ -44,12 +44,12 @@ protected abstract ScmResult executeBranchCommand( ScmProviderRepository reposit
     /**
      * default impl to provide backward comp
      * @since 1.3
-     * @param repository
-     * @param fileSet
-     * @param branchName
-     * @param scmBranchParameters
-     * @return
-     * @throws ScmException
+     * @param repository TODO
+     * @param fileSet TODO
+     * @param branchName TODO
+     * @param scmBranchParameters TODO
+     * @return TODO
+     * @throws ScmException if any
      */
     protected ScmResult executeBranchCommand( ScmProviderRepository repository, ScmFileSet fileSet, String branchName,
                                               ScmBranchParameters scmBranchParameters )

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmRequest.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmRequest.java
@@ -63,6 +63,7 @@ public Date getStartDate()
 
     /**
      * @param startDate the start date of the period
+	 * @throws ScmException if any
      */
     public void setStartDate( Date startDate )
         throws ScmException
@@ -78,6 +79,7 @@ public Date getEndDate()
 
     /**
      * @param endDate the end date of the period
+	 * @throws ScmException if any
      */
     public void setEndDate( Date endDate )
         throws ScmException
@@ -93,6 +95,7 @@ public int getNumDays()
 
     /**
      * @param numDays the number days before the current time if startdate and enddate are null
+	 * @throws ScmException if any
      */
     public void setNumDays( int numDays )
         throws ScmException
@@ -108,6 +111,7 @@ public ScmVersion getStartRevision()
 
     /**
      * @param startRevision the start branch/tag/revision
+	 * @throws ScmException if any
      */
     public void setStartRevision( ScmVersion startRevision )
         throws ScmException
@@ -123,6 +127,7 @@ public ScmVersion getEndRevision()
 
     /**
      * @param endRevision the end branch/tag/revision
+	 * @throws ScmException if any
      */
     public void setEndRevision( ScmVersion endRevision )
         throws ScmException
@@ -138,6 +143,7 @@ public String getDatePattern()
 
     /**
      * @param datePattern the date pattern used in changelog output returned by scm tool
+	 * @throws ScmException if any
      */
     public void setDatePattern( String datePattern )
         throws ScmException
@@ -154,6 +160,7 @@ public Integer getLimit()
 
     /**
      * @param limit the maximal count of returned changesets
+	 * @throws ScmException if any
      */
     public void setLimit( Integer limit )
         throws ScmException

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogSet.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogSet.java
@@ -136,6 +136,8 @@ public void setChangeSets( List<ChangeSet> changeSets )
 
     /**
      * Creates an XML representation of this change log set with a default encoding (ISO-8859-1).
+     *
+     * @return TODO
      */
     public String toXML()
     {
@@ -144,6 +146,9 @@ public String toXML()
 
     /**
      * Creates an XML representation of this change log set.
+     *
+     * @param encoding encoding of output
+     * @return TODO
      */
     public String toXML( String encoding )
     {

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/CheckInScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/CheckInScmResult.java
@@ -52,9 +52,9 @@ public CheckInScmResult( String commandLine, List<ScmFile> checkedInFiles )
     }
 
     /**
-     * @param commandLine
-     * @param checkedInFiles
-     * @param scmRevision
+     * @param commandLine TODO
+     * @param checkedInFiles TODO
+     * @param scmRevision TODO
      * @since 1.2
      */
     public CheckInScmResult( String commandLine, List<ScmFile> checkedInFiles, String scmRevision )

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/CheckOutScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/CheckOutScmResult.java
@@ -45,7 +45,7 @@ public class CheckOutScmResult
     /**
      * The relative path of the directory of the checked out project in comparison to the checkout directory, or
      * an empty String in case the checkout directory equals the project directory.
-     * <p/>
+     * <p>
      * With most SCMs, this is just an empty String, meaning that the checkout directory equals the project directory.
      * But there are cases (e.g. ClearCase) where within the checkout directory, the directory structure of the
      * SCM system is repeated. E.g. if you check out the project "my/project" to "/some/dir", the project sources

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/AbstractListCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/AbstractListCommand.java
@@ -41,8 +41,9 @@ public abstract class AbstractListCommand
      * @param repository what to list
      * @param fileSet    the files to list
      * @param recursive  whether list should return subfolder listing
+     * @param scmVersion TODO
      * @return the list of files
-     * @throws ScmException
+     * @throws ScmException if any
      */
     protected abstract ListScmResult executeListCommand( ScmProviderRepository repository, ScmFileSet fileSet,
                                                          boolean recursive, ScmVersion scmVersion )
@@ -64,4 +65,4 @@ public ScmResult executeCommand( ScmProviderRepository repository, ScmFileSet fi
 
         return executeListCommand( repository, fileSet, recursive, scmVersion );
     }
-}
+}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/AbstractMkdirCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/AbstractMkdirCommand.java
@@ -37,12 +37,12 @@ public abstract class AbstractMkdirCommand
     /**
      * Creates directories in the remote repository.
      * 
-     * @param repository
-     * @param fileSet
+     * @param repository TODO
+     * @param fileSet TODO
+     * @param message TODO
      * @param createInLocal TODO
-     * @param scmVersion
-     * @return
-     * @throws ScmException
+     * @return TODO
+     * @throws ScmException if any
      */
     protected abstract MkdirScmResult executeMkdirCommand( ScmProviderRepository repository, ScmFileSet fileSet,
                                                            String message, boolean createInLocal )

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/AbstractTagCommand.java
@@ -38,12 +38,12 @@ public abstract class AbstractTagCommand
 {
     /**
      * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)}
-     * @param repository
-     * @param fileSet
-     * @param tagName
-     * @param message
-     * @return
-     * @throws ScmException
+     * @param repository TODO
+     * @param fileSet TODO
+     * @param tagName TODO
+     * @param message TODO
+     * @return TODO
+     * @throws ScmException if any
      */
     protected ScmResult executeTagCommand( ScmProviderRepository repository, ScmFileSet fileSet, String tagName,
                                            String message )

diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java
@@ -81,6 +81,9 @@ protected void setScmProviders( Map<String, ScmProvider> providers )
 
     /**
      * @deprecated use {@link #setScmProvider(String, ScmProvider)} instead
+
+     * @param providerType the type of SCM, eg. <code>svn</code>, <code>git</code>
+     * @param provider     the provider that will be used for that SCM type
      */
     protected void addScmProvider( String providerType, ScmProvider provider )
     {