Fix Javadoc 8 issues
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
index 2d4c4e5..e4c40d6 100644
--- 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 @@
/**
* @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 @@
}
/**
- * @return
+ * @return TODO
* @since 1.3
*/
public String getRevision()
@@ -424,7 +424,7 @@
}
/**
- * @param revision
+ * @param revision TODO
* @since 1.3
*/
public void setRevision( String revision )
@@ -494,7 +494,7 @@
* 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 @@
/**
* <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
index 7aa8ae4..3c71b65 100644
--- 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 @@
* @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
index 1e861b2..6a3a872 100644
--- 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
index ae1ef0e..aefd9a5 100644
--- 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 @@
/**
* 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
index 446fd65..09fbf4d 100644
--- 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 @@
/**
* 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
index f8723c1c..a2cb04e 100644
--- 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 @@
/**
* @param startDate the start date of the period
+ * @throws ScmException if any
*/
public void setStartDate( Date startDate )
throws ScmException
@@ -78,6 +79,7 @@
/**
* @param endDate the end date of the period
+ * @throws ScmException if any
*/
public void setEndDate( Date endDate )
throws ScmException
@@ -93,6 +95,7 @@
/**
* @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 @@
/**
* @param startRevision the start branch/tag/revision
+ * @throws ScmException if any
*/
public void setStartRevision( ScmVersion startRevision )
throws ScmException
@@ -123,6 +127,7 @@
/**
* @param endRevision the end branch/tag/revision
+ * @throws ScmException if any
*/
public void setEndRevision( ScmVersion endRevision )
throws ScmException
@@ -138,6 +143,7 @@
/**
* @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 @@
/**
* @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
index e7e8323..7a545df 100644
--- 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 @@
/**
* 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 @@
/**
* 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
index d9a2d49..3a5d800 100644
--- 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 @@
}
/**
- * @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
index a9e5648..6e3ae21 100644
--- 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 @@
/**
* 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 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
index a6ee259..e5089a3 100644
--- 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 @@
* @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 @@
return executeListCommand( repository, fileSet, recursive, scmVersion );
}
-}
\ No newline at end of file
+}
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
index a1d0ecb..daa4ac5 100644
--- 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 @@
/**
* 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
index c0b4d56..17188c9 100644
--- 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 @@
{
/**
* @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
index 996bbcb..7e06bcd 100644
--- 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 @@
/**
* @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 )
{
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
index 009c527..f125b9a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java
@@ -129,7 +129,7 @@
* @param repository the source control system
* @param fileSet the files to be added
* @return an {@link org.apache.maven.scm.command.add.AddScmResult} that contains the files that have been added
- * @throws org.apache.maven.scm.ScmException
+ * @throws ScmException if any
*
*/
AddScmResult add( ScmRepository repository, ScmFileSet fileSet )
@@ -154,7 +154,7 @@
* @param fileSet the files to branch. Implementations can also give the changes from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param branchName the branch name to apply to the files
- * @return
+ * @return TODO
* @throws ScmException if any
*/
BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName )
@@ -168,7 +168,7 @@
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param branchName the branch name to apply to the files
* @param message the commit message used for the tag creation
- * @return
+ * @return TODO
* @throws ScmException if any
*/
BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName, String message )
@@ -255,7 +255,7 @@
* @param startRevision the start revision
* @param endRevision the end revision
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -267,14 +267,14 @@
/**
* Save the changes you have done into the repository. This will create a new version of the file or directory in
* the repository.
- * <p/>
+ * <p>
* When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed. When the fileSet has entries,
* the commit is non-recursive and only the elements in the fileSet are committed.
*
* @param repository the source control system
* @param fileSet the files to check in (sometimes called commit)
* @param message a string that is a comment on the changes that where done
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, String message )
@@ -283,7 +283,7 @@
/**
* Save the changes you have done into the repository. This will create a new version of the file or directory in
* the repository.
- * <p/>
+ * <p>
* When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed. When the fileSet has entries,
* the commit is non-recursive and only the elements in the fileSet are committed.
*
@@ -291,7 +291,7 @@
* @param fileSet the files to check in (sometimes called commit)
* @param revision branch/tag/revision
* @param message a string that is a comment on the changes that where done
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message )
@@ -302,7 +302,7 @@
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet )
@@ -314,7 +314,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the revision, branch or tag
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -326,7 +326,7 @@
* @param scmRepository the source control system
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param recursive whether to check out recursively
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, boolean recursive )
@@ -339,7 +339,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the revision, branch or tag
* @param recursive whether to check out recursively
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion version,
@@ -353,7 +353,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param startVersion the start branch/tag/revision
* @param endVersion the end branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
DiffScmResult diff( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion startVersion,
@@ -367,7 +367,7 @@
*
* @param repository the source control system
* @param fileSet the files to make editable
- * @return
+ * @return TODO
* @throws ScmException if any
*/
EditScmResult edit( ScmRepository repository, ScmFileSet fileSet )
@@ -378,7 +378,7 @@
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet )
@@ -390,7 +390,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -402,7 +402,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param outputDirectory the directory where the export will be stored
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, String outputDirectory )
@@ -415,7 +415,7 @@
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the branch/tag/revision
* @param outputDirectory the directory where the export will be stored
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String outputDirectory )
@@ -429,6 +429,7 @@
* @param recursive descend recursively
* @param version use the version defined by the branch/tag/revision
* @return the list of files in the repository
+ * @throws ScmException if any
*/
ListScmResult list( ScmRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion version )
throws ScmException;
@@ -436,12 +437,12 @@
/**
* Create new directory/directories in the repository.
*
- * @param repository
- * @param fileSet
- * @param message
- * @param createInLocal
- * @return
- * @throws ScmException
+ * @param repository TODO
+ * @param fileSet TODO
+ * @param message TODO
+ * @param createInLocal TODO
+ * @return TODO
+ * @throws ScmException if any
*/
MkdirScmResult mkdir( ScmRepository repository, ScmFileSet fileSet, String message, boolean createInLocal )
throws ScmException;
@@ -451,8 +452,8 @@
*
* @param repository the source control system
* @param fileSet the files to be removed
- * @param message
- * @return
+ * @param message TODO
+ * @return TODO
* @throws ScmException if any
*/
RemoveScmResult remove( ScmRepository repository, ScmFileSet fileSet, String message )
@@ -465,7 +466,7 @@
* @param repository the source control system
* @param fileSet the files to know the status about. Implementations can also give the changes from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
- * @return
+ * @return TODO
* @throws ScmException if any
*/
StatusScmResult status( ScmRepository repository, ScmFileSet fileSet )
@@ -478,7 +479,7 @@
* @param fileSet the files to tag. Implementations can also give the changes from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param tagName the tag name to apply to the files
- * @return
+ * @return TODO
* @throws ScmException if any
*/
TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName )
@@ -492,7 +493,7 @@
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param tagName the tag name to apply to the files
* @param message the commit message used for the tag creation
- * @return
+ * @return TODO
* @throws ScmException if any
*/
TagScmResult tag( ScmRepository repository, ScmFileSet fileSet, String tagName, String message )
@@ -505,7 +506,7 @@
*
* @param repository the source control system
* @param fileSet the files to make uneditable
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UnEditScmResult unedit( ScmRepository repository, ScmFileSet fileSet )
@@ -516,7 +517,7 @@
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet )
@@ -528,7 +529,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -540,7 +541,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param runChangelog Run the changelog command after the update
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, boolean runChangelog )
@@ -553,7 +554,7 @@
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
* @param runChangelog Run the changelog command after the update
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, boolean runChangelog )
@@ -565,7 +566,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, String datePattern )
@@ -578,7 +579,7 @@
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String datePattern )
@@ -589,8 +590,8 @@
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @param lastUpdate
- * @return
+ * @param lastUpdate TODO
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, Date lastUpdate )
@@ -602,8 +603,8 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
- * @param lastUpdate
- * @return
+ * @param lastUpdate TODO
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate )
@@ -616,7 +617,7 @@
* @param fileSet location of your local copy
* @param lastUpdate Date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, Date lastUpdate, String datePattern )
@@ -630,7 +631,7 @@
* @param version use the version defined by the branch/tag/revision
* @param lastUpdate Date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate,
@@ -651,7 +652,7 @@
throws ScmException;
/**
- * @param blameScmRequest
+ * @param blameScmRequest TODO
* @return blame for specified file
* @throws ScmException if any
* @since 1.4
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java
index dcacd11..de30c6f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java
@@ -707,7 +707,7 @@
*
* @param repository the source control system
* @param fileSet the files to list
- * @param parameters
+ * @param parameters TODO
* @return The list of files in the repository
* @throws NoSuchCommandScmException unless overriden by subclass
* @throws ScmException if any
@@ -747,11 +747,11 @@
/**
* Create directory/directories in the repository.
*
- * @param repository
- * @param fileSet
- * @param parameters
- * @return
- * @throws ScmException
+ * @param repository TODO
+ * @param fileSet TODO
+ * @param parameters TODO
+ * @return TODO
+ * @throws ScmException if any
*/
protected MkdirScmResult mkdir( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
throws ScmException
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java
index db60ef8..d7e69e9 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java
@@ -156,9 +156,9 @@
* @param fileSet the files to branch. Implementations can also give the changes
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param branchName the branch name to apply to the files
- * @return
+ * @return TODO
* @throws ScmException if any
- * @deprecated use {@link #branch(ScmRepository, ScmFileSet, String, String, ScmBranchParameters)}
+ * @deprecated use {@link #branch(ScmRepository, ScmFileSet, String, ScmBranchParameters)}
*/
BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName )
throws ScmException;
@@ -171,9 +171,9 @@
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param branchName the branch name to apply to the files
* @param message the commit message used for the tag creation
- * @return
+ * @return TODO
* @throws ScmException if any
- * @deprecated use {@link #branch(ScmRepository, ScmFileSet, String, String, ScmBranchParameters)}
+ * @deprecated use {@link #branch(ScmRepository, ScmFileSet, String, ScmBranchParameters)}
*/
BranchScmResult branch( ScmRepository repository, ScmFileSet fileSet, String branchName, String message )
throws ScmException;
@@ -186,7 +186,8 @@
* @param fileSet the files to branch. Implementations can also give the changes from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param branchName the branch name to apply to the files
- * @return
+ * @param scmBranchParameters TODO
+ * @return TODO
* @throws ScmException if any
* @since 1.3
*/
@@ -333,7 +334,7 @@
* @param startTag the start tag
* @param endTag the end tag
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -352,7 +353,7 @@
* @param startRevision the start revision
* @param endRevision the end revision
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -364,7 +365,7 @@
/**
* Save the changes you have done into the repository. This will create a new version of the file or
* directory in the repository.
- * <p/>
+ * <p>
* When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed.
* When the fileSet has entries, the commit is non-recursive and only the elements in the fileSet
* are committed.
@@ -373,7 +374,7 @@
* @param fileSet the files to check in (sometimes called commit)
* @param tag tag or revision
* @param message a string that is a comment on the changes that where done
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#checkIn(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)}
@@ -384,7 +385,7 @@
/**
* Save the changes you have done into the repository. This will create a new version of the file or
* directory in the repository.
- * <p/>
+ * <p>
* When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed.
* When the fileSet has entries, the commit is non-recursive and only the elements in the fileSet
* are committed.
@@ -392,7 +393,7 @@
* @param repository the source control system
* @param fileSet the files to check in (sometimes called commit)
* @param message a string that is a comment on the changes that where done
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, String message )
@@ -401,7 +402,7 @@
/**
* Save the changes you have done into the repository. This will create a new version of the file or
* directory in the repository.
- * <p/>
+ * <p>
* When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed.
* When the fileSet has entries, the commit is non-recursive and only the elements in the fileSet
* are committed.
@@ -410,7 +411,7 @@
* @param fileSet the files to check in (sometimes called commit)
* @param revision branch/tag/revision
* @param message a string that is a comment on the changes that where done
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckInScmResult checkIn( ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message )
@@ -422,7 +423,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param tag get the version defined by the tag
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)}
@@ -435,7 +436,7 @@
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet )
@@ -447,7 +448,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the revision, branch or tag
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -460,7 +461,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param tag tag or revision
* @param recursive whether to check out recursively
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#checkOut(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, boolean)}
@@ -474,7 +475,7 @@
* @param scmRepository the source control system
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param recursive whether to check out recursively
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, boolean recursive )
@@ -487,7 +488,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the revision, branch or tag
* @param recursive whether to check out recursively
- * @return
+ * @return TODO
* @throws ScmException if any
*/
CheckOutScmResult checkOut( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion version,
@@ -502,7 +503,7 @@
* location
* @param version get the version defined by the revision, branch or tag
* @param commandParameters parameters
- * @return
+ * @return TODO
* @throws ScmException if any
* @since 1.9.6
*/
@@ -517,7 +518,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param startRevision the start revision
* @param endRevision the end revision
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#diff(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, org.apache.maven.scm.ScmVersion)}
@@ -532,7 +533,7 @@
* @param scmFileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param startVersion the start branch/tag/revision
* @param endVersion the end branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
DiffScmResult diff( ScmRepository scmRepository, ScmFileSet scmFileSet, ScmVersion startVersion,
@@ -545,7 +546,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param tag get the version defined by the tag
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)}
@@ -558,7 +559,7 @@
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet )
@@ -570,7 +571,7 @@
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -583,7 +584,7 @@
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param tag get the version defined by the tag
* @param outputDirectory the directory where the export will be stored
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#export(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)}
@@ -598,7 +599,7 @@
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
* @param version get the version defined by the branch/tag/revision
* @param outputDirectory the directory where the export will be stored
- * @return
+ * @return TODO
* @throws ScmException if any
*/
ExportScmResult export( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String outputDirectory )
@@ -609,8 +610,8 @@
*
* @param repository the source control system
* @param fileSet the files to be removed
- * @param message
- * @return
+ * @param message TODO
+ * @return TODO
* @throws ScmException if any
*/
RemoveScmResult remove( ScmRepository repository, ScmFileSet fileSet, String message )
@@ -623,7 +624,7 @@
* @param repository the source control system
* @param fileSet the files to know the status about. Implementations can also give the changes
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
- * @return
+ * @return TODO
* @throws ScmException if any
*/
StatusScmResult status( ScmRepository repository, ScmFileSet fileSet )
@@ -636,7 +637,7 @@
* @param fileSet the files to tag. Implementations can also give the changes
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param tagName the tag name to apply to the files
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated use {@link #tag(ScmRepository, ScmFileSet, String, ScmTagParameters)}
*/
@@ -648,8 +649,8 @@
*
* @param repository the source control system
* @param fileSet a fileset with the relevant working directory as basedir
- * @param parameters
- * @return
+ * @param parameters TODO
+ * @return TODO
* @throws ScmException if any
*/
UntagScmResult untag( ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters )
@@ -663,7 +664,7 @@
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param tagName the tag name to apply to the files
* @param message the commit message used for the tag creation
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated use {@link #tag(ScmRepository, ScmFileSet, String, ScmTagParameters)}
*/
@@ -678,7 +679,7 @@
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param tagName the tag name to apply to the files
* @param scmTagParameters bean to pass some paramters for tagging {@link ScmTagParameters}
- * @return
+ * @return TODO
* @throws ScmException if any
* @since 1.2
*/
@@ -690,7 +691,7 @@
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet )
@@ -702,7 +703,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param tag use the version defined by the tag
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion)}
@@ -716,7 +717,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version )
@@ -729,7 +730,7 @@
* @param fileSet location of your local copy
* @param tag use the version defined by the tag
* @param runChangelog Run the changelog command after the update
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, boolean)}
@@ -743,7 +744,7 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param runChangelog Run the changelog command after the update
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, boolean runChangelog )
@@ -756,7 +757,7 @@
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
* @param runChangelog Run the changelog command after the update
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, boolean runChangelog )
@@ -769,7 +770,7 @@
* @param fileSet location of your local copy
* @param tag use the version defined by the tag
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, String)}
@@ -784,7 +785,7 @@
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, String datePattern )
@@ -796,8 +797,8 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param tag use the version defined by the tag
- * @param lastUpdate
- * @return
+ * @param lastUpdate TODO
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, java.util.Date)}
@@ -811,8 +812,8 @@
* @param repository the source control system
* @param fileSet location of your local copy
* @param version use the version defined by the branch/tag/revision
- * @param lastUpdate
- * @return
+ * @param lastUpdate TODO
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate )
@@ -826,7 +827,7 @@
* @param tag use the version defined by the tag
* @param lastUpdate Date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.ScmVersion, java.util.Date, String)}
@@ -843,7 +844,7 @@
* @param version use the version defined by the branch/tag/revision
* @param lastUpdate Date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UpdateScmResult update( ScmRepository repository, ScmFileSet fileSet, ScmVersion version, Date lastUpdate,
@@ -857,7 +858,7 @@
*
* @param repository the source control system
* @param fileSet the files to make editable
- * @return
+ * @return TODO
* @throws ScmException if any
*/
EditScmResult edit( ScmRepository repository, ScmFileSet fileSet )
@@ -870,7 +871,7 @@
*
* @param repository the source control system
* @param fileSet the files to make uneditable
- * @return
+ * @return TODO
* @throws ScmException if any
*/
UnEditScmResult unedit( ScmRepository repository, ScmFileSet fileSet )
@@ -884,6 +885,7 @@
* @param recursive descend recursively
* @param tag use the version defined by the tag
* @return the list of files in the repository
+ * @throws ScmException if any
* @deprecated you must use {@link ScmProvider#list(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, boolean, org.apache.maven.scm.ScmVersion)}
*/
@@ -910,7 +912,7 @@
* @param fileSet location of your local copy
* @param filename file
* @return blame for specified file
- * @throws ScmException
+ * @throws ScmException if any
* @since 1.4
* @deprecated use blame with {@link BlameScmRequest} parameter
*/
@@ -919,9 +921,9 @@
/**
*
- * @param blameScmRequest
+ * @param blameScmRequest TODO
* @return blame for the file specified in the request
- * @throws ScmException
+ * @throws ScmException if any
* @since 1.8
*/
BlameScmResult blame( BlameScmRequest blameScmRequest )
@@ -931,12 +933,12 @@
/**
* Create directory/directories in the repository.
*
- * @param repository
- * @param fileSet
- * @param createInLocal
- * @param message
- * @return
- * @throws ScmException
+ * @param repository TODO
+ * @param fileSet TODO
+ * @param createInLocal TODO
+ * @param message TODO
+ * @return TODO
+ * @throws ScmException if any
*/
MkdirScmResult mkdir( ScmRepository repository, ScmFileSet fileSet, String message, boolean createInLocal )
throws ScmException;
@@ -946,7 +948,7 @@
* @param fileSet location of your local copy
* @param parameters some parameters (not use currently but for future use)
* @return if the scm implementation doesn't support "info" result will <code>null</code>
- * @throws ScmException
+ * @throws ScmException if any
* @since 1.5
*/
InfoScmResult info( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
@@ -957,7 +959,7 @@
* @param fileSet not use currently but for future use
* @param parameters some parameters (not use currently but for future use)
* @return if the scm implementation doesn't support "info" result will <code>null</code>
- * @throws ScmException
+ * @throws ScmException if any
* @since 1.6
*/
RemoteInfoScmResult remoteInfo( ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters )
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java
index 39f70b2..a32e76a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepository.java
@@ -106,6 +106,7 @@
* For many distributed SCMs like Git, a change like a commit
* is only stored in your local copy of the repository. Pushing
* the change allows your to more easily share it with other users.
+ * @return TODO
* @since 1.4
*/
public boolean isPushChanges()
@@ -115,7 +116,7 @@
/**
* @since 1.4
- * @param pushChanges
+ * @param pushChanges TODO
*/
public void setPushChanges( boolean pushChanges )
{
@@ -135,7 +136,7 @@
/**
* Set the workItem.
*
- * @param user The workItem.
+ * @param workItem The workItem.
* @since 1.9.5
*/
@Deprecated
@@ -151,11 +152,12 @@
* user checks out to. If false, the server entry (clientspec in Perforce
* terminology) will be deleted after the checkout is complete so the
* files will not be able to be updated.
- * <p/>
+ * <p>
* This setting can be overriden by using the system property
* "maven.scm.persistcheckout" to true.
- * <p/>
+ * <p>
* The default is false. See SCM-113 for more detail.
+ * @return TODO
*/
@Deprecated
public boolean isPersistCheckout()
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java
index e2f6634..e1bef9e 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmUrlUtils.java
@@ -25,7 +25,7 @@
/**
* A utility class that validates and parses scm url:s. The code here is
* <strong>not</strong> scm provider specific.
- * <p/>
+ * <p>
* If you need methods that work for a specific scm provider, please create a
* similar class for that provider. E.g. create the class SvnScmUrlUtils if
* you need Subversion-specific checking/parsing.
@@ -101,7 +101,7 @@
/**
* Validate that the scm url is in the correct format.
- * <p/>
+ * <p>
* <strong>Note</strong>: does not validate scm provider specific format.
* </p>
*
@@ -118,7 +118,7 @@
/**
* Validate that the scm url is in the correct format.
- * <p/>
+ * <p>
* <strong>Note</strong>: does not validate scm provider specific format.
* </p>
*
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepository.java b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepository.java
index ae6aeab..1b51179 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepository.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepository.java
@@ -24,7 +24,7 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
*
- * @todo clarify need - should be able to merge with ScmProviderRepository?
+ * TODO clarify need - should be able to merge with ScmProviderRepository?
*/
public class ScmRepository
{
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/util/AbstractConsumer.java b/maven-scm-api/src/main/java/org/apache/maven/scm/util/AbstractConsumer.java
index 389d7a4..8069101 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/util/AbstractConsumer.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/util/AbstractConsumer.java
@@ -61,6 +61,9 @@
/**
* Converts the date timestamp from the output into a date object.
*
+ * @param date TODO
+ * @param userPattern TODO
+ * @param defaultPattern TODO
* @return A date representing the timestamp of the log entry.
*/
protected Date parseDate( String date, String userPattern, String defaultPattern )
@@ -71,6 +74,10 @@
/**
* Converts the date timestamp from the output into a date object.
*
+ * @param date TODO
+ * @param userPattern TODO
+ * @param defaultPattern TODO
+ * @param locale TODO
* @return A date representing the timestamp of the log entry.
*/
protected Date parseDate( String date, String userPattern, String defaultPattern, Locale locale )
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/util/ConsumerUtils.java b/maven-scm-api/src/main/java/org/apache/maven/scm/util/ConsumerUtils.java
index a18ec57..9272ae5 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/util/ConsumerUtils.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/util/ConsumerUtils.java
@@ -39,9 +39,9 @@
/**
* Read file f, sending each line to the consumer.
*
- * @param f
- * @param consumer
- * @throws IOException
+ * @param f TODO
+ * @param consumer TODO
+ * @throws IOException if any
*/
public static void consumeFile( File f, StreamConsumer consumer ) throws IOException
{
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/util/FilenameUtils.java b/maven-scm-api/src/main/java/org/apache/maven/scm/util/FilenameUtils.java
index 8030fc3..907149a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/util/FilenameUtils.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/util/FilenameUtils.java
@@ -40,8 +40,8 @@
/**
* Replace duplicated [back]slash to slash.
*
- * @param filename
- * @return
+ * @param filename TODO
+ * @return TODO
*/
public static String normalizeFilename( String filename )
{
diff --git a/maven-scm-managers/maven-scm-manager-plexus/pom.xml b/maven-scm-managers/maven-scm-manager-plexus/pom.xml
index 1923dd0..1425b84 100644
--- a/maven-scm-managers/maven-scm-manager-plexus/pom.xml
+++ b/maven-scm-managers/maven-scm-manager-plexus/pom.xml
@@ -56,7 +56,7 @@
<goals>
<goal>generate-metadata</goal>
</goals>
- </execution>
+ </execution>
</executions>
</plugin>
</plugins>
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
index ecc4dd2..e146b1c 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
@@ -195,7 +195,7 @@
* @param checkoutDirectory
* @param relativePathProjectDirectory
* @param goalsDirectory
- * @return
+ * @return TODO
*/
protected String determineWorkingDirectoryPath( File checkoutDirectory, String relativePathProjectDirectory,
String goalsDirectory )
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgUtils.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgUtils.java
index 3648e5c..c787d8f 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgUtils.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgUtils.java
@@ -231,7 +231,7 @@
/**
* Get current (working) revision.
- * <p/>
+ * <p>
* Resolve revision to the last integer found in the command output.
*/
private static class HgRevNoConsumer
@@ -305,7 +305,7 @@
* Check if there are outgoing changes on a different branch. If so, Mercurial default behaviour
* is to block the push and warn using a 'push creates new remote branch !' message.
* We also warn, and return true if a different outgoing branch was found
- * <p/>
+ * <p>
* Method users should not stop the push on a negative return, instead, they should
* hg push -r(branch being released)
*
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java
index 64a6f98..ede3501 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgCommandConstants.java
@@ -22,7 +22,7 @@
/**
* Available/Used hg commands.
- * <p/>
+ * <p>
* These commands do not necessarily correspond to the SCM API.
* Eg. "check in" is translated to be "commit" and "push".
*
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgConsumer.java
index d2b9d91..20886cc 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/HgConsumer.java
@@ -31,7 +31,7 @@
/**
* Base consumer to do common parsing for all hg commands.
- * <p/>
+ * <p>
* More specific: log line each line if debug is enabled, get file status
* and detect warnings from hg
*
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/metadata/LocalScmMetadataUtils.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/metadata/LocalScmMetadataUtils.java
index 9446b9d..e7e1984 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/metadata/LocalScmMetadataUtils.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/metadata/LocalScmMetadataUtils.java
@@ -58,7 +58,7 @@
* Builds LocalScmMetadata based on contents of repository
*
* @param repository
- * @return
+ * @return TODO
* @throws IOException if any
*/
public LocalScmMetadata buildMetadata( File repository )
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
index 6553c05..1a24204 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/GitScmProviderRepository.java
@@ -241,7 +241,7 @@
/**
* @param repoUrl
- * @return
+ * @return TODO
*/
private String getUrl( RepositoryUrl repoUrl )
{
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
index bb1dad1..4f25def 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/GitCommandLineUtils.java
@@ -89,7 +89,7 @@
*
* @param workingDirectory
* @param command
- * @return
+ * @return TODO
*/
public static Commandline getBaseGitCommandLine( File workingDirectory, String command )
{
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkout/GitCheckOutCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkout/GitCheckOutCommand.java
index 7fcda9c..a831e5b 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkout/GitCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkout/GitCheckOutCommand.java
@@ -56,7 +56,7 @@
* For git, the given repository is a remote one.
* We have to clone it first if the working directory does not contain a git repo yet,
* otherwise we have to git-pull it.
- * <p/>
+ * <p>
* TODO We currently assume a '.git' directory, so this does not work for --bare repos
* {@inheritDoc}
*/
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/info/GitInfoCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/info/GitInfoCommand.java
index d129ed3..c5a4256 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/info/GitInfoCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/info/GitInfoCommand.java
@@ -83,7 +83,7 @@
* Get the revision length from the parameters
*
* @param parameters
- * @return -1 if parameter {@link CommandParameter.SCM_SHORT_REVISION_LENGTH} is absent, <br/>
+ * @return -1 if parameter {@link CommandParameter.SCM_SHORT_REVISION_LENGTH} is absent, <br>
* and otherwise - the length to be applied for the revision formatting
* @throws ScmException
* @since 1.7
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/status/GitStatusConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/status/GitStatusConsumer.java
index c5e87c9..d01eb21 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/status/GitStatusConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/status/GitStatusConsumer.java
@@ -102,7 +102,7 @@
* @param workingDirectory the working directory
* @param relativeRepositoryPath the working directory relative to the repository root
* @since 1.9
- * @see GitStatusCommand#createRevparseShowPrefix(org.apache.maven.scm.ScmFileSet)
+ * @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
*/
public GitStatusConsumer( ScmLogger logger, File workingDirectory, URI relativeRepositoryPath )
{
@@ -121,7 +121,7 @@
* @param workingDirectory the working directory
* @param scmFileSet fileset with includes and excludes
* @since 1.11.0
- * @see GitStatusCommand#createRevparseShowToplevelCommand(org.apache.maven.scm.ScmFileSet)
+ * @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
*/
public GitStatusConsumer( ScmLogger logger, File workingDirectory, ScmFileSet scmFileSet )
{
@@ -141,7 +141,7 @@
* @param relativeRepositoryPath the working directory relative to the repository root
* @param scmFileSet fileset with includes and excludes
* @since 1.11.0
- * @see GitStatusCommand#createRevparseShowToplevelCommand(org.apache.maven.scm.ScmFileSet)
+ * @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
*/
public GitStatusConsumer( ScmLogger logger, File workingDirectory, URI relativeRepositoryPath,
ScmFileSet scmFileSet )
@@ -305,7 +305,7 @@
*
* @param fileEntry the fileEntry, must not be {@code null}
* @param path the path, must not be {@code null}
- * @return
+ * @return TODO
*/
public static URI resolveURI( String fileEntry, URI path )
{
@@ -365,7 +365,7 @@
* Dequote a quoted string generated by git status --porcelain.
* The leading and trailing quotes have already been removed.
* @param fileEntry
- * @return
+ * @return TODO
*/
private static String unescape( String fileEntry )
{
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
index 6ad56ba..cc18268 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
@@ -126,9 +126,9 @@
/**
* Prepares the in memory configuration of git to connect to the configured
- * repository. It configures the following settings in memory: <br />
- * <li>push url</li> <li>fetch url</li>
- * <p/>
+ * repository. It configures the following settings in memory: <br>
+ * <ul><li>push url</li> <li>fetch url</li></ul>
+ * <p>
*
* @param logger used to log some details
* @param git the instance to configure (only in memory, not saved)
@@ -164,9 +164,9 @@
/**
* Creates a credentials provider from the information passed in the
- * repository. Current implementation supports: <br />
- * <li>UserName/Password</li>
- * <p/>
+ * repository. Current implementation supports: <br>
+ * <ul><li>UserName/Password</li></ul>
+ * <p>
*
* @param repository the config to get the details from
* @return <code>null</code> if there is not enough info to create a
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/checkout/JGitCheckOutCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/checkout/JGitCheckOutCommand.java
index 0ba09b7..9f77ade 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/checkout/JGitCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/checkout/JGitCheckOutCommand.java
@@ -66,7 +66,7 @@
/**
* For git, the given repository is a remote one. We have to clone it first if the working directory does not
* contain a git repo yet, otherwise we have to git-pull it.
- * <p/>
+ * <p>
* {@inheritDoc}
*/
protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repo, ScmFileSet fileSet,
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnCommandUtils.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnCommandUtils.java
index d4f1c20..dc5d9a1 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnCommandUtils.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnCommandUtils.java
@@ -36,12 +36,12 @@
/**
* Add or overrides the username into a url with a svn+ssh scheme.
- * <p/>
+ * <p>
* Svn 1.3.1 doesn't use the username information specified by --username when the url
* uses the svn+ssh scheme. This allows to fix it. See MRELEASE-35.
- * </p>
+ * <p>
* Convert file url which derived from windows file path to unix path.
- * </p>
+ *
* @param url the url, not <code>null</code>
* @param username the username, may be <code>null</code>
* @return the fixed url
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnTagBranchUtils.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnTagBranchUtils.java
index 1ebeff4..6656eb1 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnTagBranchUtils.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnTagBranchUtils.java
@@ -70,7 +70,7 @@
* directories
*
* @param repoPath Repository path/url to be searched
- * @return
+ * @return TODO
*/
public static String getProjectRoot( String repoPath )
{
@@ -120,7 +120,7 @@
*
* @param repository the repository to use as a base for tag resolution
* @param tag tag name
- * @return
+ * @return TODO
* @see #resolveUrl(String,String,String,ScmBranch)
*/
public static String resolveTagUrl( SvnScmProviderRepository repository, ScmTag tag )
@@ -134,7 +134,7 @@
*
* @param repositoryUrl string url for the repository
* @param tag tag name
- * @return
+ * @return TODO
* @see #resolveUrl(String,String,String,ScmBranch)
*/
public static String resolveTagUrl( String repositoryUrl, ScmTag tag )
@@ -149,7 +149,7 @@
*
* @param repository the repository to use as a base for tag resolution
* @param branch tag name
- * @return
+ * @return TODO
* @see #resolveUrl(String,String,String,ScmBranch)
*/
public static String resolveBranchUrl( SvnScmProviderRepository repository, ScmBranch branch )
@@ -163,7 +163,7 @@
*
* @param repositoryUrl string url for the repository
* @param branch branch name
- * @return
+ * @return TODO
* @see #resolveUrl(String,String,String,ScmBranch)
*/
public static String resolveBranchUrl( String repositoryUrl, ScmBranch branch )
@@ -181,11 +181,11 @@
* Resolves a tag or branch name to a repository url.<br>
* If the <code>branchTagName</code> is an absolute URL, that value is returned.
* (i.e. http://foo.com/svn/myproject/tags/my-tag)<br>
- * <p/>
+ * <p>
* If the repository has a {@link SvnScmProviderRepository#getTagBase()} specified,
* the tag is simply appended to the tagBase value. Note that at this time, we are using
* the tagBase as a base for both branches and tags.<br>
- * <p/>
+ * <p>
* If the <code>branchTagName</code> contains a branch/tag specifier (i.e. "/branches", "/tags", "/trunk"),
* the <code>branchTagName</code> is appended to the <code>projectRoot</code> without adding the subdir.<br>
* Else, the result is in the format of <code>projectRoot/subdir/branchTagName</code> directory.<br>
@@ -196,7 +196,7 @@
* (for branching use "branches", tags use "tags")
* @param branchTag Name of the actual branch or tag. Can be an absolute url, simple tag/branch name,
* or even contain a relative path to the root like "branches/my-branch"
- * @return
+ * @return TODO
*/
public static String resolveUrl( String repositoryUrl, String tagBase, String subdir, ScmBranch branchTag )
{
@@ -274,7 +274,7 @@
* "BASE" base rev of item's working copy
* "COMMITTED" last commit at or before BASE
* "PREV"
- * <p/>
+ * <p>
* For command such as diff, the revision argument can be in the format of:
* IDENTIFIER:IDENTIFIER where IDENTIFIER is one of the args listed above
*/
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/branch/SvnBranchCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/branch/SvnBranchCommand.java
index cd78617..8929635 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/branch/SvnBranchCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/branch/SvnBranchCommand.java
@@ -50,7 +50,7 @@
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
*
- * @todo since this is just a copy, use that instead.
+ * TODO since this is just a copy, use that instead.
*/
public class SvnBranchCommand
extends AbstractBranchCommand
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/tag/SvnTagCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/tag/SvnTagCommand.java
index f5f7a17..3bcdd82 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/tag/SvnTagCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/tag/SvnTagCommand.java
@@ -51,7 +51,7 @@
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
*
- * @todo since this is just a copy, use that instead.
+ * TODO since this is just a copy, use that instead.
*/
public class SvnTagCommand
extends AbstractTagCommand
@@ -200,7 +200,7 @@
* @param workingDirectory
* @param tag
* @param messageFile
- * @return
+ * @return TODO
*/
public static Commandline createCommandLine( SvnScmProviderRepository repository, File workingDirectory, String tag,
File messageFile )
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/list/SvnListCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/list/SvnListCommandTckTest.java
index 20ca5db..4f2a402 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/list/SvnListCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/list/SvnListCommandTckTest.java
@@ -25,7 +25,7 @@
import java.io.File;
/**
- * Test for <code>list<code> command
+ * Test for {@code list} command
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
*
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java
index 89471ac..996a4fe 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTckTestCase.java
@@ -35,10 +35,8 @@
import org.codehaus.plexus.util.StringUtils;
/**
- * <p/>
* Base class for all TcK tests.
- * </p>
- * <p/>
+ * <p>
* Basically all it does is to setup a default test enviroment
* common for all tck tests. The default setup includes:
* <ol>
@@ -46,7 +44,6 @@
* <li>Initialize the repository</li>
* <li>Check out the repository to the working copy</li>
* </ol>
- * </p>
*
* @author <a href="mailto:torbjorn@smorgrav.org">Torbj�rn Eikli Sm�rgrav</a>
*
@@ -66,7 +63,7 @@
throws Exception;
/**
- * <p/>
+ * <p>
* Get the list of file names that is supposed to be in the test repo.
* </p>
* <ul>
@@ -84,10 +81,10 @@
}
/**
- * <p/>
+ * <p>
* Initialize repository at the {@link #getScmUrl()} location with the files in {@link #getScmFileNames()}
* </p>
- * <p/>
+ * <p>
* The setup is also asserting on the existence of these files. <br>
* This should only be used by this class (thus do not call this method from derived classes)
* </p>
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/remoteinfo/AbstractRemoteInfoCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/remoteinfo/AbstractRemoteInfoCommandTckTest.java
index 69b4d9d..e7e8e0b 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/remoteinfo/AbstractRemoteInfoCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/remoteinfo/AbstractRemoteInfoCommandTckTest.java
@@ -27,10 +27,10 @@
/**
* This test tests the remote info command.
- * <p/>
+ * <p>
* This test have to be subclassed. The expected result have to be implemented in
* sub class
- * <p/>
+ * <p>
*
* @author Bertrand Paquet
*/
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/status/StatusCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/status/StatusCommandTckTest.java
index 8329ed5..6b07a0c 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/status/StatusCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/status/StatusCommandTckTest.java
@@ -36,9 +36,9 @@
/**
* This test tests the status command.
- * <p/>
+ * <p>
* It works like this:
- * <p/>
+ * <p>
* <ol>
* <li>Check out the files to directory getWorkingCopy().
* <li>Check out the files to directory getUpdatingCopy().
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/update/UpdateCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/update/UpdateCommandTckTest.java
index 006a673..8020bba 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/update/UpdateCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/update/UpdateCommandTckTest.java
@@ -39,9 +39,9 @@
/**
* This test tests the update command.
- * <p/>
+ * <p>
* It works like this:
- * <p/>
+ * <p>
* <ol>
* <li>Check out the files to directory getWorkingCopy().
* <li>Check out the files to directory getUpdatingCopy().
diff --git a/pom.xml b/pom.xml
index 3ea7f80..85ba538 100644
--- a/pom.xml
+++ b/pom.xml
@@ -313,6 +313,18 @@
</dependency>
</dependencies>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <tags>
+ <tag>
+ <name>plexus.component</name>
+ <placement>X</placement>
+ </tag>
+ </tags>
+ </configuration>
+ </plugin>
</plugins>
</build>
