You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2021/12/28 20:06:25 UTC
[maven-scm] branch maven-scm-1.x updated: Fix Javadoc 8 issues
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch maven-scm-1.x
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
The following commit(s) were added to refs/heads/maven-scm-1.x by this push:
new e670d1d Fix Javadoc 8 issues
e670d1d is described below
commit e670d1de4eef99ccfe595e3fd1a2f88d60ca2843
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Tue Dec 28 20:20:32 2021 +0100
Fix Javadoc 8 issues
---
.../main/java/org/apache/maven/scm/ChangeSet.java | 12 +-
.../org/apache/maven/scm/CommandParameters.java | 1 +
.../java/org/apache/maven/scm/ScmFileStatus.java | 10 +-
.../main/java/org/apache/maven/scm/ScmResult.java | 2 +-
.../scm/command/branch/AbstractBranchCommand.java | 12 +-
.../scm/command/changelog/ChangeLogScmRequest.java | 7 ++
.../maven/scm/command/changelog/ChangeLogSet.java | 5 +
.../scm/command/checkin/CheckInScmResult.java | 6 +-
.../scm/command/checkout/CheckOutScmResult.java | 2 +-
.../scm/command/list/AbstractListCommand.java | 5 +-
.../scm/command/mkdir/AbstractMkdirCommand.java | 10 +-
.../maven/scm/command/tag/AbstractTagCommand.java | 12 +-
.../maven/scm/manager/AbstractScmManager.java | 3 +
.../org/apache/maven/scm/manager/ScmManager.java | 87 +++++++-------
.../maven/scm/provider/AbstractScmProvider.java | 12 +-
.../org/apache/maven/scm/provider/ScmProvider.java | 126 +++++++++++----------
.../maven/scm/provider/ScmProviderRepository.java | 10 +-
.../org/apache/maven/scm/provider/ScmUrlUtils.java | 6 +-
.../apache/maven/scm/repository/ScmRepository.java | 2 +-
.../apache/maven/scm/util/AbstractConsumer.java | 7 ++
.../org/apache/maven/scm/util/ConsumerUtils.java | 6 +-
.../org/apache/maven/scm/util/FilenameUtils.java | 4 +-
.../maven-scm-manager-plexus/pom.xml | 2 +-
.../org/apache/maven/scm/plugin/BootstrapMojo.java | 2 +-
.../scm/provider/accurev/AccuRevCapability.java | 2 +-
.../accurev/AccuRevScmProviderRepository.java | 2 +-
.../accurev/command/add/AccuRevAddCommand.java | 2 +-
.../command/update/AccuRevUpdateScmResult.java | 6 +-
.../maven/scm/provider/bazaar/BazaarUtils.java | 2 +-
.../provider/bazaar/command/BazaarConstants.java | 2 +-
.../provider/bazaar/command/BazaarConsumer.java | 2 +-
.../repository/ClearCaseScmProviderRepository.java | 10 +-
.../org/apache/maven/scm/provider/hg/HgUtils.java | 4 +-
.../provider/hg/command/HgCommandConstants.java | 2 +-
.../maven/scm/provider/hg/command/HgConsumer.java | 2 +-
.../maven/scm/provider/integrity/Member.java | 2 +-
.../maven/scm/provider/integrity/Project.java | 1 -
.../maven/scm/provider/jazz/JazzScmProvider.java | 10 +-
.../scm/provider/jazz/command/JazzScmCommand.java | 6 +-
.../command/changelog/JazzHistoryConsumer.java | 4 +-
.../changelog/JazzListChangesetConsumer.java | 14 +--
.../jazz/command/consumer/DebugLoggerConsumer.java | 4 +-
.../jazz/command/status/JazzStatusConsumer.java | 4 +-
.../jazz/repository/JazzScmProviderRepository.java | 4 +-
.../command/status/JazzStatusConsumerTest.java | 2 +-
.../local/metadata/LocalScmMetadataUtils.java | 2 +-
.../scm/provider/perforce/PerforceScmProvider.java | 8 +-
.../perforce/command/PerforceInfoCommand.java | 6 +-
.../perforce/command/PerforceWhereCommand.java | 2 +-
.../command/checkout/PerforceCheckOutCommand.java | 4 +-
.../perforce/command/tag/PerforceTagConsumer.java | 2 +-
.../command/update/SynergyUpdateCommand.java | 2 +-
.../consumer/SynergyCreateTaskConsumer.java | 2 +-
.../consumer/SynergyGetWorkingProjectConsumer.java | 2 +-
.../synergy/consumer/SynergyWorkareaConsumer.java | 10 +-
.../scm/provider/synergy/util/SynergyUtil.java | 3 -
.../provider/vss/commands/VssParameterContext.java | 4 +-
.../vss/commands/checkin/VssCheckInCommand.java | 4 -
.../cvslib/command/add/AbstractCvsAddCommand.java | 2 +-
.../cvslib/command/diff/CvsDiffConsumer.java | 2 +-
.../scm/provider/cvslib/command/login/CvsPass.java | 2 +-
.../command/remove/AbstractCvsRemoveCommand.java | 2 +-
.../scm/provider/cvslib/AbstractCvsScmTest.java | 2 +-
.../command/checkout/CvsCheckoutCommandTest.java | 4 +-
.../command/update/CvsUpdateCommandTest.java | 2 +-
.../git/repository/GitScmProviderRepository.java | 2 +-
.../git/gitexe/command/GitCommandLineUtils.java | 2 +-
.../command/checkout/GitCheckOutCommand.java | 2 +-
.../git/gitexe/command/info/GitInfoCommand.java | 2 +-
.../gitexe/command/status/GitStatusConsumer.java | 10 +-
.../scm/provider/git/jgit/command/JGitUtils.java | 12 +-
.../jgit/command/checkout/JGitCheckOutCommand.java | 2 +-
.../maven/scm/provider/svn/SvnCommandUtils.java | 6 +-
.../maven/scm/provider/svn/SvnTagBranchUtils.java | 18 +--
.../svnexe/command/branch/SvnBranchCommand.java | 2 +-
.../svn/svnexe/command/tag/SvnTagCommand.java | 4 +-
.../svn/command/list/SvnListCommandTckTest.java | 2 +-
.../java/org/apache/maven/scm/ScmTckTestCase.java | 11 +-
.../AbstractRemoteInfoCommandTckTest.java | 4 +-
.../tck/command/status/StatusCommandTckTest.java | 4 +-
.../tck/command/update/UpdateCommandTckTest.java | 4 +-
pom.xml | 12 ++
82 files changed, 316 insertions(+), 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
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 @@ public class ChangeSet
/**
* @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 class ChangeSet
}
/**
- * @return
+ * @return TODO
* @since 1.3
*/
public String getRevision()
@@ -424,7 +424,7 @@ public class ChangeSet
}
/**
- * @param revision
+ * @param revision TODO
* @since 1.3
*/
public void setRevision( String revision )
@@ -494,7 +494,7 @@ public class ChangeSet
* 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 @@ public class ChangeSet
/**
* <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 @@ public class CommandParameters
* @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 @@ package org.apache.maven.scm;
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 @@ 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
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 @@ public abstract class AbstractBranchCommand
/**
* 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 @@ public class ChangeLogScmRequest
/**
* @param startDate the start date of the period
+ * @throws ScmException if any
*/
public void setStartDate( Date startDate )
throws ScmException
@@ -78,6 +79,7 @@ public class ChangeLogScmRequest
/**
* @param endDate the end date of the period
+ * @throws ScmException if any
*/
public void setEndDate( Date endDate )
throws ScmException
@@ -93,6 +95,7 @@ public class ChangeLogScmRequest
/**
* @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 class ChangeLogScmRequest
/**
* @param startRevision the start branch/tag/revision
+ * @throws ScmException if any
*/
public void setStartRevision( ScmVersion startRevision )
throws ScmException
@@ -123,6 +127,7 @@ public class ChangeLogScmRequest
/**
* @param endRevision the end branch/tag/revision
+ * @throws ScmException if any
*/
public void setEndRevision( ScmVersion endRevision )
throws ScmException
@@ -138,6 +143,7 @@ public class ChangeLogScmRequest
/**
* @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 class ChangeLogScmRequest
/**
* @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 @@ public class ChangeLogSet
/**
* 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 class ChangeLogSet
/**
* 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 @@ public class CheckInScmResult
}
/**
- * @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 d4bdb4f..7c3fce3 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 @@ 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
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 @@ 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 abstract class AbstractListCommand
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 @@ 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
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 @@ 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
index f393ac9..4aaee1d 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 @@ public abstract class AbstractScmManager
/**
* @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 697f6b7..a6d8816 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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* {@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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
/**
* 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 @@ public interface ScmManager
/**
* 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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
/**
* 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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* {@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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
*
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
* @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 @@ public interface ScmManager
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 @@ public abstract class AbstractScmProvider
*
* @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 @@ public abstract class AbstractScmProvider
/**
* 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 5e0d79f..54a3725 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
@@ -155,9 +155,9 @@ public interface ScmProvider
* @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;
@@ -170,9 +170,9 @@ public interface ScmProvider
* 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;
@@ -185,7 +185,8 @@ public interface ScmProvider
* @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
*/
@@ -332,7 +333,7 @@ public interface ScmProvider
* @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
*/
@@ -351,7 +352,7 @@ public interface ScmProvider
* @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
*/
@@ -363,7 +364,7 @@ public interface ScmProvider
/**
* 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.
@@ -372,7 +373,7 @@ public interface ScmProvider
* @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)}
@@ -383,7 +384,7 @@ public interface ScmProvider
/**
* 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.
@@ -391,7 +392,7 @@ public interface ScmProvider
* @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 )
@@ -400,7 +401,7 @@ public interface ScmProvider
/**
* 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.
@@ -409,7 +410,7 @@ public interface ScmProvider
* @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 )
@@ -421,7 +422,7 @@ public interface ScmProvider
* @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)}
@@ -434,7 +435,7 @@ public interface ScmProvider
*
* @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 )
@@ -446,7 +447,7 @@ public interface ScmProvider
* @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 )
@@ -459,7 +460,7 @@ public interface ScmProvider
* @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)}
@@ -473,7 +474,7 @@ public interface ScmProvider
* @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 )
@@ -486,7 +487,7 @@ public interface ScmProvider
* @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,
@@ -501,7 +502,7 @@ public interface ScmProvider
* 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
*/
@@ -516,7 +517,7 @@ public interface ScmProvider
* @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)}
@@ -531,7 +532,7 @@ public interface ScmProvider
* @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,
@@ -544,7 +545,7 @@ public interface ScmProvider
* @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)}
@@ -557,7 +558,7 @@ public interface ScmProvider
*
* @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 )
@@ -569,7 +570,7 @@ public interface ScmProvider
* @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 )
@@ -582,7 +583,7 @@ public interface ScmProvider
* @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)}
@@ -597,7 +598,7 @@ public interface ScmProvider
* @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 )
@@ -608,8 +609,8 @@ public interface ScmProvider
*
* @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 )
@@ -622,7 +623,7 @@ public interface ScmProvider
* @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 )
@@ -635,7 +636,7 @@ public interface ScmProvider
* @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)}
*/
@@ -647,8 +648,8 @@ public interface ScmProvider
*
* @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 )
@@ -662,7 +663,7 @@ public interface ScmProvider
* 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)}
*/
@@ -677,7 +678,7 @@ public interface ScmProvider
* 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
*/
@@ -689,7 +690,7 @@ public interface ScmProvider
*
* @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 )
@@ -701,7 +702,7 @@ public interface ScmProvider
* @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)}
@@ -715,7 +716,7 @@ public interface ScmProvider
* @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 )
@@ -728,7 +729,7 @@ public interface ScmProvider
* @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)}
@@ -742,7 +743,7 @@ public interface ScmProvider
* @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 )
@@ -755,7 +756,7 @@ public interface ScmProvider
* @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 )
@@ -768,7 +769,7 @@ public interface ScmProvider
* @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)}
@@ -783,7 +784,7 @@ public interface ScmProvider
* @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 )
@@ -795,8 +796,8 @@ public interface ScmProvider
* @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)}
@@ -810,8 +811,8 @@ public interface ScmProvider
* @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 )
@@ -825,7 +826,7 @@ public interface ScmProvider
* @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)}
@@ -842,7 +843,7 @@ public interface ScmProvider
* @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,
@@ -856,7 +857,7 @@ public interface ScmProvider
*
* @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 )
@@ -869,7 +870,7 @@ public interface ScmProvider
*
* @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 )
@@ -883,6 +884,7 @@ public interface ScmProvider
* @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)}
*/
@@ -909,7 +911,7 @@ public interface ScmProvider
* @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
*/
@@ -918,9 +920,9 @@ public interface ScmProvider
/**
*
- * @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 )
@@ -930,12 +932,12 @@ public interface ScmProvider
/**
* 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;
@@ -945,7 +947,7 @@ public interface ScmProvider
* @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 )
@@ -956,7 +958,7 @@ public interface ScmProvider
* @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 f75f64d..46a59ff 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
@@ -104,6 +104,7 @@ public abstract class ScmProviderRepository
* 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()
@@ -113,7 +114,7 @@ public abstract class ScmProviderRepository
/**
* @since 1.4
- * @param pushChanges
+ * @param pushChanges TODO
*/
public void setPushChanges( boolean pushChanges )
{
@@ -132,7 +133,7 @@ public abstract class ScmProviderRepository
/**
* Set the workItem.
*
- * @param user The workItem.
+ * @param workItem The workItem.
* @since 1.9.5
*/
public void setWorkItem( String workItem )
@@ -147,11 +148,12 @@ public abstract class ScmProviderRepository
* 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
*/
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 32afa85..2c3f782 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 @@ import java.util.List;
/**
* 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 CvsScmUrlUtils if
* you need cvs specific checking/parsing.
@@ -101,7 +101,7 @@ public abstract class ScmUrlUtils
/**
* 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 @@ public abstract class ScmUrlUtils
/**
* 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 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
/**
* @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 @@ public abstract class AbstractConsumer
/**
* 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 @@ public abstract class AbstractConsumer
/**
* 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 @@ public class ConsumerUtils
/**
* 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 @@ public final class FilenameUtils
/**
* 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 2428ff9..1384886 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 eed57e9..32f6591 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
@@ -196,7 +196,7 @@ public class BootstrapMojo
* @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-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevCapability.java b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevCapability.java
index 0765b01..7917a11 100644
--- a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevCapability.java
+++ b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevCapability.java
@@ -40,7 +40,7 @@ public enum AccuRevCapability
}
/**
- * @todo simple string compare because the version numbers have never used
+ * TODO simple string compare because the version numbers have never used
* more than one digit.
* @param version
* @return if the capability is available for this version
diff --git a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevScmProviderRepository.java b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevScmProviderRepository.java
index 9c6e467..878ca11 100644
--- a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/AccuRevScmProviderRepository.java
@@ -160,7 +160,7 @@ public class AccuRevScmProviderRepository
/**
* 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 are
diff --git a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/add/AccuRevAddCommand.java b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/add/AccuRevAddCommand.java
index bc18427..35e940a 100644
--- a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/add/AccuRevAddCommand.java
+++ b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/add/AccuRevAddCommand.java
@@ -52,7 +52,7 @@ public class AccuRevAddCommand
/**
* Add.
*
- * @todo handle the "binary" parameter. AccuRev does a reasonable job of detecting this itself.
+ * TODO handle the "binary" parameter. AccuRev does a reasonable job of detecting this itself.
*/
protected ScmResult executeAccurevCommand( AccuRevScmProviderRepository repository, ScmFileSet fileSet,
CommandParameters parameters )
diff --git a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/update/AccuRevUpdateScmResult.java b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/update/AccuRevUpdateScmResult.java
index 326795b..e95a10c 100644
--- a/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/update/AccuRevUpdateScmResult.java
+++ b/maven-scm-providers/maven-scm-provider-accurev/src/main/java/org/apache/maven/scm/provider/accurev/command/update/AccuRevUpdateScmResult.java
@@ -53,10 +53,10 @@ public class AccuRevUpdateScmResult
/**
* Success constructor
*
- * @param startVersion
- * @param endVersion
* @param commandLines
* @param updatedFiles
+ * @param fromRevision
+ * @param toRevision
*/
public AccuRevUpdateScmResult( String commandLines, List<ScmFile> updatedFiles, String fromRevision,
String toRevision )
@@ -74,4 +74,4 @@ public class AccuRevUpdateScmResult
{
return getRevision();
}
-}
\ No newline at end of file
+}
diff --git a/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/BazaarUtils.java b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/BazaarUtils.java
index 0af6671..d1f9c94 100644
--- a/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/BazaarUtils.java
+++ b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/BazaarUtils.java
@@ -206,7 +206,7 @@ public final class BazaarUtils
/**
* Get current (working) revision.
- * <p/>
+ * <p>
* Resolve revision to the last integer found in the command output.
*/
private static class BazaarRevNoConsumer
diff --git a/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConstants.java b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConstants.java
index 2283595..3ec3d52 100644
--- a/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConstants.java
+++ b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConstants.java
@@ -22,7 +22,7 @@ package org.apache.maven.scm.provider.bazaar.command;
/**
* Available/Used bazaar commands.
- * <p/>
+ * <p>
* These commands does 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-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConsumer.java b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConsumer.java
index 4c070ff..aa5349c 100644
--- a/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-bazaar/src/main/java/org/apache/maven/scm/provider/bazaar/command/BazaarConsumer.java
@@ -30,7 +30,7 @@ import java.util.Map;
/**
* Base consumer to do common parsing for all bazaar commands.
- * <p/>
+ * <p>
* More specific: log line each line if debug is enabled, get file status
* and detect warnings from bazaar
*
diff --git a/maven-scm-providers/maven-scm-provider-clearcase/src/main/java/org/apache/maven/scm/provider/clearcase/repository/ClearCaseScmProviderRepository.java b/maven-scm-providers/maven-scm-provider-clearcase/src/main/java/org/apache/maven/scm/provider/clearcase/repository/ClearCaseScmProviderRepository.java
index 9512f2a..1f99d01 100644
--- a/maven-scm-providers/maven-scm-provider-clearcase/src/main/java/org/apache/maven/scm/provider/clearcase/repository/ClearCaseScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-provider-clearcase/src/main/java/org/apache/maven/scm/provider/clearcase/repository/ClearCaseScmProviderRepository.java
@@ -35,13 +35,13 @@ import java.util.StringTokenizer;
/**
* Provider Repository for ClearCase (standard, LT, UCM)
- * <p />
- * Url format for ClearCase and ClearCaseLT : <br />
+ * <p>
+ * Url format for ClearCase and ClearCaseLT : <br>
* [view_name]:[configspec] or [view_name]|[configspec]
- * <p />
- * Url format for ClearCaseUCM : <br />
+ * <p>
+ * Url format for ClearCaseUCM : <br>
* [view_name]|[configspec]|[vob_name]|[stream_name] or [view_name]:[configspec]:[vob_name]:[stream_name]
- * <p />
+ * <p>
* [configspec] can be used in two different ways:
* <ul>
* <li>Path to a config spec file that is
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 @@ public final class HgUtils
/**
* 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 @@ public final class HgUtils
* 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 @@ package org.apache.maven.scm.provider.hg.command;
/**
* 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 @@ import java.util.Map;
/**
* 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-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Member.java b/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Member.java
index 1d8c955..799095b 100644
--- a/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Member.java
+++ b/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Member.java
@@ -190,7 +190,7 @@ public class Member
* Optionally, one might want to restore the timestamp, if the build is smart not to recompile files that were not
* touched.
*
- * @param restoreTimestamp
+ * @param restoreTime
*/
public void setRestoreTimestamp( boolean restoreTime )
{
diff --git a/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Project.java b/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Project.java
index 451584a..f59c2e7 100644
--- a/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Project.java
+++ b/maven-scm-providers/maven-scm-provider-integrity/src/main/java/org/apache/maven/scm/provider/integrity/Project.java
@@ -79,7 +79,6 @@ public class Project
* <br>If it's invalid, this method throws an exception providing the reason as string.
*
* @param tagName The checkpoint label name
- * @return the error message, or null if label is valid
*/
public static void validateTag( String tagName )
throws Exception
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/JazzScmProvider.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/JazzScmProvider.java
index 9ba37b4..8fdf2fc 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/JazzScmProvider.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/JazzScmProvider.java
@@ -59,12 +59,12 @@ import java.net.URI;
/**
* The maven scm provider for Jazz.
- * <p/>
+ * <p>
* This provider is a wrapper for the command line tool, "scm.sh" or "scm.exe" is that is
* part of the Jazz SCM Server.
- * <p/>
+ * <p>
* This provider does not use a native API to communicate with the Jazz SCM server.
- * <p/>
+ * <p>
* The scm tool itself is documented at:
* V2.0.0 - http://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
* V3.0 - http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
@@ -94,12 +94,12 @@ public class JazzScmProvider
/**
* This method parses the scm URL and returns a SCM provider repository.
* At this point, the scmUrl is the part after scm:provider_name: in your SCM URL.
- * <p/>
+ * <p>
* The basic url parsing approach is to be as loose as possible.
* If you specify as per the docs you'll get what you expect.
* If you do something else the result is undefined.
* Don't use "/" "\" or "@" as the delimiter.
- * <p/>
+ * <p>
* Parse the scmUrl, which will be of the form:
* [username[;password]@]http[s]://server_name[:port]/contextRoot:repositoryWorkspace
* eg:
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/JazzScmCommand.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/JazzScmCommand.java
index b30a1fe..1983aa7 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/JazzScmCommand.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/JazzScmCommand.java
@@ -37,9 +37,9 @@ import java.util.Iterator;
/**
* The base class for the underlying jazz "scm.sh"/"scm.exe" command.
- * <p/>
+ * <p>
* The SCM command is documented here:
- * <p/>
+ * <p>
* V2.0.2: http://publib.boulder.ibm.com/infocenter/rtc/v2r0m0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
* V3.0: http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
* V3.0.1: http://publib.boulder.ibm.com/infocenter/clmhelp/v3r0m1/topic/com.ibm.team.scm.doc/topics/r_scm_cli_scm.html
@@ -56,8 +56,6 @@ public class JazzScmCommand
/**
* Create a JazzScmCommand when no sub-command is needed.
- *
- * @throws ScmException
*/
public JazzScmCommand( String cmd, ScmProviderRepository repo, ScmFileSet fileSet, ScmLogger logger )
{
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzHistoryConsumer.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzHistoryConsumer.java
index 04e0c67..e261972 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzHistoryConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzHistoryConsumer.java
@@ -30,10 +30,10 @@ import java.util.regex.Pattern;
/**
* Consume the output of the scm command for the "history" operation.
- * <p/>
+ * <p>
* It is passed in a List of ChangeSet entries. All we do is to parse
* the Jazz change set aliases, and save as the revision into the list.
- * <p/>
+ * <p>
* NOTE: We do not set the command or date or anything other than the revision
* here, as we pick that information up from the "scm list changeset" command.
*
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzListChangesetConsumer.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzListChangesetConsumer.java
index e78caa2..c49e51f 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzListChangesetConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/changelog/JazzListChangesetConsumer.java
@@ -36,7 +36,7 @@ import java.util.regex.Pattern;
/**
* Consume the output of the scm command for the "list changesets" operation.
- * <p/>
+ * <p>
* This parses the contents of the output and uses it to fill in the remaining
* information in the <code>entries</code> list.
*
@@ -411,7 +411,7 @@ public class JazzListChangesetConsumer
}
/**
- * String the leading/trailing ", < and > from the text.
+ * String the leading/trailing ", < and > from the text.
*
* @param text The text to process.
* @return The striped text.
@@ -437,9 +437,9 @@ public class JazzListChangesetConsumer
/**
* Parse the change state file flags from Jazz and map them to the maven SCM ones.
- * <p/>
+ * <p>
* "----" Character positions 0-3.
- * <p/>
+ * <p>
* [0] is '*' or '-' Indicates that this is the current change set ('*') or not ('-'). STATE_CHANGESET_CURRENT
* [1] is '!' or '-' Indicates a Potential Conflict ('!') or not ('-'). STATE_POTENTIAL_CONFLICT
* [2] is '#' or '-' Indicates a Conflict ('#') or not ('-'). STATE_CONFLICT
@@ -461,9 +461,9 @@ public class JazzListChangesetConsumer
/**
* Parse the change state file flags from Jazz and map them to the maven SCM ones.
- * <p/>
+ * <p>
* "-----" Character positions 0-4. The default is '-'.
- * <p/>
+ * <p>
* [0] is '-' or '!' Indicates a Potential Conflict. STATE_POTENTIAL_CONFLICT
* [1] is '-' or '#' Indicates a Conflict. STATE_CONFLICT
* [2] is '-' or 'a' Indicates an addition. STATE_ADD
@@ -471,7 +471,7 @@ public class JazzListChangesetConsumer
* or 'm' Indicates a move. STATE_MOVE
* [3] is '-' or 'c' Indicates a content change. STATE_CONTENT_CHANGE
* [4] is '-' or 'p' Indicates a property change. STATE_PROPERTY_CHANGE
- * <p/>
+ * <p>
* NOTE: [3] and [4] can only be set it [2] is NOT 'a' or 'd'.
*
* @param state The 5 character long state string
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/consumer/DebugLoggerConsumer.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/consumer/DebugLoggerConsumer.java
index f5243ec..888f239 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/consumer/DebugLoggerConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/consumer/DebugLoggerConsumer.java
@@ -24,12 +24,12 @@ import org.apache.maven.scm.log.ScmLogger;
/**
* This class exists only to consume output that is normally not needed,
* though it may be of interest when in debug mode.
- * <p/>
+ * <p>
* For example, "scm lock acquire" produces:
* "Locks successfully acquired."
* and "scm lock release" produces:
* "Locks successfully released."
- * <p/>
+ * <p>
* So, basically nothing of real interest to parse and pass back.
*
* @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a>
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumer.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumer.java
index b96b87e..0e7e80f 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumer.java
@@ -33,14 +33,14 @@ import java.util.regex.Pattern;
/**
* Consume the output of the scm command for the "status" operation.
- * <p/>
+ * <p>
* It is normally just used to build up a list of ScmFile objects that have
* their ScmFileStatus set.
* This class has been expanded so that the Workspace, Component and Baseline
* are also collected and set back in the JazzScmProviderRepository.
* The Workspace and Component names are needed for some other commands (list,
* for example), so we can easily get this information here.
- * <p/>
+ * <p>
* As this class has expanded over time, it has become more and more of a state
* machine, one that needs to parse the output of the "scm status --wide" command.
* If there are any issues with this provider, I would suggest this is a good
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/repository/JazzScmProviderRepository.java b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/repository/JazzScmProviderRepository.java
index 9951e9d..b39e75d 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/repository/JazzScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/main/java/org/apache/maven/scm/provider/jazz/repository/JazzScmProviderRepository.java
@@ -257,7 +257,7 @@ public class JazzScmProviderRepository
}
/**
- * @return The List<Integer> of aliases of the outgoing changesets, as returned from the "scm status" command.
+ * @return The List<Integer> of aliases of the outgoing changesets, as returned from the "scm status" command.
*/
public List<Integer> getOutgoingChangeSetAliases()
{
@@ -273,7 +273,7 @@ public class JazzScmProviderRepository
}
/**
- * @return The List<Integer> of aliases of the incoming changesets, as returned from the "scm status" command.
+ * @return The List<Integer> of aliases of the incoming changesets, as returned from the "scm status" command.
*/
public List<Integer> getIncomingChangeSetAliases()
{
diff --git a/maven-scm-providers/maven-scm-provider-jazz/src/test/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumerTest.java b/maven-scm-providers/maven-scm-provider-jazz/src/test/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumerTest.java
index 190a12a..3c54a6c 100644
--- a/maven-scm-providers/maven-scm-provider-jazz/src/test/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumerTest.java
+++ b/maven-scm-providers/maven-scm-provider-jazz/src/test/java/org/apache/maven/scm/provider/jazz/command/status/JazzStatusConsumerTest.java
@@ -47,7 +47,7 @@ public class JazzStatusConsumerTest
}
@Ignore
- // @todo fix JazzStatusConsumer to match the ScmFile restrictions
+ // TODO fix JazzStatusConsumer to match the ScmFile restrictions
public void testScmFilePath()
{
statusConsumer = new JazzStatusConsumer( null, scmLogger );
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 @@ public class LocalScmMetadataUtils
* 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-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/PerforceScmProvider.java b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/PerforceScmProvider.java
index 1ea0d1c..695b6a6 100644
--- a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/PerforceScmProvider.java
+++ b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/PerforceScmProvider.java
@@ -335,10 +335,10 @@ public class PerforceScmProvider
/**
* Given a path like "//depot/foo/bar", returns the
* proper path to include everything beneath it.
- * <p/>
- * //depot/foo/bar -> //depot/foo/bar/...
- * //depot/foo/bar/ -> //depot/foo/bar/...
- * //depot/foo/bar/... -> //depot/foo/bar/...
+ * <p>
+ * //depot/foo/bar -> //depot/foo/bar/...
+ * //depot/foo/bar/ -> //depot/foo/bar/...
+ * //depot/foo/bar/... -> //depot/foo/bar/...
*
* @param repoPath
* @return
diff --git a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceInfoCommand.java b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceInfoCommand.java
index 73d517f..dc33246 100644
--- a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceInfoCommand.java
+++ b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceInfoCommand.java
@@ -42,18 +42,18 @@ import java.util.Map;
* Encapsulates the 'p4 info' command which can be very useful in determining
* the runtime environment. Use <code>getEntry(String key)</code> to query
* the info set for a particular property. The data from p4 info looks like this:
- * <p/>
+ * <p>
* <pre>
* User name: mperham
* Client name: mikeperham-dt
* Client host: mikeperham-dt
* Client root: d:\perforce
* </pre>
- * <p/>
+ * <p>
* where the key is the content before the first colon and the value is the data after
* the first colon, trimmed. For example:
* <code>PerforceInfoCommand.getInfo( this, repo ).getEntry( "User name" )</code>
- * <p/>
+ * <p>
* Note that this is not a traditional SCM command. This uses the Command class
* simply because it needs a logger for error handling and the current repository data for
* command line creation.
diff --git a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceWhereCommand.java b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceWhereCommand.java
index 11358b6..2826b86 100644
--- a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceWhereCommand.java
+++ b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/PerforceWhereCommand.java
@@ -35,7 +35,7 @@ import java.io.InputStreamReader;
* Encapsulates the 'p4 where' command which can be very useful in determining
* a file's location within the depot. Use <code>getDepotLocation(String path)</code> to query
* the depot location for a particular file. The data from p4 where looks like this:
- * <p/>
+ * <p>
* <pre>
* p4 where pom.xml
* //depot/modules/fabric/trunk/pom.xml //mikeperham-dt/depot/modules/fabric/trunk/pom.xml
diff --git a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/checkout/PerforceCheckOutCommand.java b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/checkout/PerforceCheckOutCommand.java
index 42a4803..a1cee2e 100644
--- a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/checkout/PerforceCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/checkout/PerforceCheckOutCommand.java
@@ -57,11 +57,11 @@ public class PerforceCheckOutCommand
* directory at <code>files.getBasedir</code>. Perforce does not support
* arbitrary checkout of versioned source so we need to set up a well-known
* clientspec which will hold the required info.
- * <p/>
+ * <p>
* 1) A clientspec will be created or updated which holds a temporary
* mapping from the repo path to the target directory.
* 2) This clientspec is sync'd to pull all the files onto the client
- * <p/>
+ * <p>
* {@inheritDoc}
*/
protected CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repo, ScmFileSet files,
diff --git a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/tag/PerforceTagConsumer.java b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/tag/PerforceTagConsumer.java
index a739cb3..1977a73 100644
--- a/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/tag/PerforceTagConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-perforce/src/main/java/org/apache/maven/scm/provider/perforce/command/tag/PerforceTagConsumer.java
@@ -55,7 +55,7 @@ public class PerforceTagConsumer
/**
* Return a list of Strings formatted like:
- * <p/>
+ * <p>
* <pre>
* //depot/modules/cordoba/runtime-ear/pom.xml
* //depot/modules/cordoba/runtime-ear/.runtime
diff --git a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/command/update/SynergyUpdateCommand.java b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/command/update/SynergyUpdateCommand.java
index 2cf7597..88f8207 100644
--- a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/command/update/SynergyUpdateCommand.java
+++ b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/command/update/SynergyUpdateCommand.java
@@ -115,7 +115,7 @@ public class SynergyUpdateCommand
/**
* Copies a entire directory structure and collect modifications.
- * <p/>
+ * <p>
* Note:
* <ul>
* <li>It will include empty directories.
diff --git a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyCreateTaskConsumer.java b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyCreateTaskConsumer.java
index 12646c5..039629c 100644
--- a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyCreateTaskConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyCreateTaskConsumer.java
@@ -46,7 +46,7 @@ public class SynergyCreateTaskConsumer
}
/**
- * Task 70 created. <br/> The default task is set to: <br/> 70: Maven SCM
+ * Task 70 created. <br> The default task is set to: <br> 70: Maven SCM
* Synergy provider: adding file(s) to project TestMaven~1
*
* {@inheritDoc}
diff --git a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyGetWorkingProjectConsumer.java b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyGetWorkingProjectConsumer.java
index a87c9ca..3b7fc7c 100644
--- a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyGetWorkingProjectConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyGetWorkingProjectConsumer.java
@@ -24,7 +24,7 @@ import org.codehaus.plexus.util.cli.StreamConsumer;
/**
* Parse output of
- * <p/>
+ * <p>
* <pre>
* ccm wa -show -p <project_spec>
* </pre>
diff --git a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyWorkareaConsumer.java b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyWorkareaConsumer.java
index ec996e0..ad11b19 100644
--- a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyWorkareaConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/consumer/SynergyWorkareaConsumer.java
@@ -26,7 +26,7 @@ import java.io.File;
/**
* Parse output of
- * <p/>
+ * <p>
* <pre>
* ccm wa -show -p <project_spec>
* </pre>
@@ -48,19 +48,19 @@ public class SynergyWorkareaConsumer
/**
* We are expecting the following output:
- * <p/>
+ * <p>
* <pre>
* Project Maintain Copies Relative Time Translate Modify Path
* -------------------------------------------------------------------
* BGZBFZH˜1 TRUE TRUE FALSE FALSE TRUE FALSE 'D:\cmsynergy\ccm_wa\LAPOSTE\BGZBFZH˜1'
* </pre>
- * <p/>
+ * <p>
* And we want to extract:
- * <p/>
+ * <p>
* <pre>
* D:\cmsynergy\ccm_wa\LAPOSTE\BGZBFZH˜1
* <pre>
- *
+ * </pre>
* {@inheritDoc}
*/
public void consumeLine( String line )
diff --git a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/util/SynergyUtil.java b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/util/SynergyUtil.java
index 806bebc..6b5bcc5 100644
--- a/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/util/SynergyUtil.java
+++ b/maven-scm-providers/maven-scm-provider-synergy/src/main/java/org/apache/maven/scm/provider/synergy/util/SynergyUtil.java
@@ -543,7 +543,6 @@ public final class SynergyUtil
* @param directory new project work area, or null if you want to use default wa.
* @param projectSpec projectSpec (i.e. myProject~1).
* @param ccmAddr used to run in multi-session.
- * @return checkout directory (directory + new project spec)
* @throws ScmException
*/
public static void checkoutProject( ScmLogger logger, File directory, String projectSpec, ScmVersion version,
@@ -571,7 +570,6 @@ public final class SynergyUtil
* @param projectSpec projectSpec (i.e. myProject~1).
* @param comment message.
* @param ccmAddr used to run in multi-session.
- * @return checkout directory (directory + new project spec)
* @throws ScmException
*/
public static void checkinProject( ScmLogger logger, String projectSpec, String comment, String ccmAddr )
@@ -596,7 +594,6 @@ public final class SynergyUtil
*
* @param logger a logger.
* @param ccmAddr used to run in multi-session.
- * @return checkout directory (directory + new project spec)
* @throws ScmException
*/
public static void checkinFiles( ScmLogger logger, List<File> files, String comment, String ccmAddr )
diff --git a/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/VssParameterContext.java b/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/VssParameterContext.java
index d4bec30..67fb195 100644
--- a/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/VssParameterContext.java
+++ b/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/VssParameterContext.java
@@ -129,7 +129,7 @@ public class VssParameterContext
/**
* Calculate the start date for version comparison.
- * <p/>
+ * <p>
* Calculate the date numDay days earlier than startdate.
*
* @param startDate The start date.
@@ -166,7 +166,7 @@ public class VssParameterContext
/**
* Gets the localpath string. "-GLc:\source"
- * <p/>
+ * <p>
* The localpath is created if it didn't exist.
*
* @return An empty string if localpath is not set.
diff --git a/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/checkin/VssCheckInCommand.java b/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/checkin/VssCheckInCommand.java
index 3494746..4b97109 100644
--- a/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/checkin/VssCheckInCommand.java
+++ b/maven-scm-providers/maven-scm-provider-vss/src/main/java/org/apache/maven/scm/provider/vss/commands/checkin/VssCheckInCommand.java
@@ -49,10 +49,6 @@ public class VssCheckInCommand
/**
* (non-Javadoc)
- *
- * @see org.apache.maven.scm.command.checkin.AbstractCheckInCommand# executeCheckInCommand
- * (org.apache.maven.scm.provider.ScmProviderRepository, org.apache.maven.scm.ScmFileSet,
- * java.lang.String, org.apache.maven.scm.ScmVersion)
*/
protected CheckInScmResult executeCheckInCommand( ScmProviderRepository repository, ScmFileSet fileSet,
String message, ScmVersion scmVersion )
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/add/AbstractCvsAddCommand.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/add/AbstractCvsAddCommand.java
index e02c6ef..ed05e14 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/add/AbstractCvsAddCommand.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/add/AbstractCvsAddCommand.java
@@ -39,7 +39,7 @@ import java.util.List;
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*
- * @todo separate the CVSlib stuff from the cvs command line so it is clear what needs to be updated eventually
+ * TODO separate the CVSlib stuff from the cvs command line so it is clear what needs to be updated eventually
*/
public abstract class AbstractCvsAddCommand
extends AbstractAddCommand
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/diff/CvsDiffConsumer.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/diff/CvsDiffConsumer.java
index 9cb387d..592f2a9 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/diff/CvsDiffConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/diff/CvsDiffConsumer.java
@@ -34,7 +34,7 @@ import java.util.Map;
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
*
- * @todo share with SVN (3 extra lines can be ignored)
+ * TODO share with SVN (3 extra lines can be ignored)
*/
public class CvsDiffConsumer
implements StreamConsumer
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/login/CvsPass.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/login/CvsPass.java
index 113f476..b37b7e0 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/login/CvsPass.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/login/CvsPass.java
@@ -33,7 +33,7 @@ import java.io.PrintWriter;
* Adds an new entry to a CVS password file.
*
*
- * @todo Update this class for support password storage in cvsnt. CVSNT use the windows registry, so, we need a jni
+ * TODO Update this class for support password storage in cvsnt. CVSNT use the windows registry, so, we need a jni
* tool for access to the windows registry
*/
public class CvsPass
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/remove/AbstractCvsRemoveCommand.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/remove/AbstractCvsRemoveCommand.java
index 0e9a758..c1b4cf7 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/remove/AbstractCvsRemoveCommand.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvs-commons/src/main/java/org/apache/maven/scm/provider/cvslib/command/remove/AbstractCvsRemoveCommand.java
@@ -40,7 +40,7 @@ import java.util.List;
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
*
- * @todo separate the CVSlib stuff from the cvs command line so it is clear what needs to be updated eventually
+ * TODO separate the CVSlib stuff from the cvs command line so it is clear what needs to be updated eventually
*/
public abstract class AbstractCvsRemoveCommand
extends AbstractRemoveCommand
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/AbstractCvsScmTest.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/AbstractCvsScmTest.java
index 36bb850..3f9332d 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/AbstractCvsScmTest.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/AbstractCvsScmTest.java
@@ -27,7 +27,7 @@ import org.codehaus.plexus.util.FileUtils;
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
*
- * @todo refactor into non-existence
+ * TODO refactor into non-existence
*/
public abstract class AbstractCvsScmTest
extends ScmTestCase
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/checkout/CvsCheckoutCommandTest.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/checkout/CvsCheckoutCommandTest.java
index 76c15a8..92573db 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/checkout/CvsCheckoutCommandTest.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/checkout/CvsCheckoutCommandTest.java
@@ -45,7 +45,7 @@ public class CvsCheckoutCommandTest
}
/**
- * @todo move this test to the TCK.
+ * TODO move this test to the TCK.
*/
public void testCheckOutWithoutTag()
throws Exception
@@ -79,7 +79,7 @@ public class CvsCheckoutCommandTest
}
/**
- * @todo move this test to the TCK - checkout with "revision", then have one for tag as well.
+ * TODO move this test to the TCK - checkout with "revision", then have one for tag as well.
*/
public void testCheckOutWithTag()
throws Exception
diff --git a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/update/CvsUpdateCommandTest.java b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/update/CvsUpdateCommandTest.java
index 19f19d3..d51b333 100644
--- a/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/update/CvsUpdateCommandTest.java
+++ b/maven-scm-providers/maven-scm-providers-cvs/maven-scm-provider-cvstest/src/main/java/org/apache/maven/scm/provider/cvslib/command/update/CvsUpdateCommandTest.java
@@ -70,7 +70,7 @@ public class CvsUpdateCommandTest
}
/**
- * @todo merge into tck
+ * TODO merge into tck
*/
public void testCvsUpdate()
throws Exception
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 @@ public class GitScmProviderRepository
/**
* @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 @@ public final class GitCommandLineUtils
*
* @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 @@ public class GitCheckOutCommand
* 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 @@ public class GitInfoCommand
* 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 @@ public class GitStatusConsumer
* @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 @@ public class GitStatusConsumer
* @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 @@ public class GitStatusConsumer
* @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 @@ public class GitStatusConsumer
*
* @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 @@ public class GitStatusConsumer
* 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 @@ public class JGitUtils
/**
* 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 @@ public class JGitUtils
/**
* 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 @@ public class JGitCheckOutCommand
/**
* 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 @@ public final class SvnCommandUtils
/**
* 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 67798f2..0b03d86 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 @@ public final class SvnTagBranchUtils
* directories
*
* @param repoPath Repository path/url to be searched
- * @return
+ * @return TODO
*/
public static String getProjectRoot( String repoPath )
{
@@ -120,7 +120,7 @@ public final class SvnTagBranchUtils
*
* @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 @@ public final class SvnTagBranchUtils
*
* @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 @@ public final class SvnTagBranchUtils
*
* @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 @@ public final class SvnTagBranchUtils
*
* @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 @@ public final class SvnTagBranchUtils
* 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 @@ public final class SvnTagBranchUtils
* (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 @@ public final class SvnTagBranchUtils
* "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 @@ import org.codehaus.plexus.util.cli.Commandline;
* @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 @@ import org.codehaus.plexus.util.cli.Commandline;
* @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 @@ public class SvnTagCommand
* @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 org.apache.maven.scm.tck.command.list.ListCommandTckTest;
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.apache.maven.scm.repository.ScmRepository;
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 @@ import org.codehaus.plexus.util.StringUtils;
* <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 @@ public abstract class ScmTckTestCase
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 @@ public abstract class ScmTckTestCase
}
/**
- * <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 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
/**
* 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 @@ import java.util.TreeSet;
/**
* 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 @@ import org.codehaus.plexus.util.StringUtils;
/**
* 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 6e2f806..15d2965 100644
--- a/pom.xml
+++ b/pom.xml
@@ -383,6 +383,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>