You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2025/09/15 17:44:11 UTC
(maven-scm) branch jd created (now dd2f73a9d)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a change to branch jd
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
at dd2f73a9d Follow Oracle Javadoc guidelines
This branch includes the following new commits:
new dd2f73a9d Follow Oracle Javadoc guidelines
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(maven-scm) 01/01: Follow Oracle Javadoc guidelines
Posted by el...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch jd
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
commit dd2f73a9dc4a624f2f7c7270c4a6945fe4d45d81
Author: Elliotte Rusty Harold <el...@ibiblio.org>
AuthorDate: Mon Sep 15 13:44:02 2025 -0400
Follow Oracle Javadoc guidelines
---
.../org/apache/maven/scm/AbstractScmVersion.java | 13 ++-
.../main/java/org/apache/maven/scm/ChangeFile.java | 26 ++---
.../main/java/org/apache/maven/scm/ChangeSet.java | 97 +++++++++---------
.../org/apache/maven/scm/CommandParameter.java | 13 +--
.../org/apache/maven/scm/CommandParameters.java | 86 ++++++++--------
.../maven/scm/NoSuchCommandScmException.java | 3 +-
.../main/java/org/apache/maven/scm/ScmBranch.java | 5 +-
.../java/org/apache/maven/scm/ScmException.java | 1 -
.../main/java/org/apache/maven/scm/ScmFile.java | 23 +++--
.../main/java/org/apache/maven/scm/ScmFileSet.java | 23 +++--
.../java/org/apache/maven/scm/ScmFileStatus.java | 23 +++--
.../main/java/org/apache/maven/scm/ScmRequest.java | 2 +
.../main/java/org/apache/maven/scm/ScmResult.java | 19 ++--
.../java/org/apache/maven/scm/ScmRevision.java | 5 +-
.../src/main/java/org/apache/maven/scm/ScmTag.java | 5 +-
.../org/apache/maven/scm/ScmTagParameters.java | 10 +-
.../org/apache/maven/scm/ScmUntagParameters.java | 18 ++--
.../main/java/org/apache/maven/scm/ScmVersion.java | 1 -
.../apache/maven/scm/command/AbstractCommand.java | 5 +-
.../java/org/apache/maven/scm/command/Command.java | 3 +-
.../maven/scm/command/add/AbstractAddCommand.java | 5 +-
.../apache/maven/scm/command/add/AddScmResult.java | 3 +-
.../apache/maven/scm/command/blame/BlameLine.java | 1 -
.../maven/scm/command/blame/BlameScmRequest.java | 2 +-
.../scm/command/branch/AbstractBranchCommand.java | 10 +-
.../maven/scm/command/branch/BranchScmResult.java | 1 -
.../changelog/AbstractChangeLogCommand.java | 1 -
.../scm/command/changelog/ChangeLogCommand.java | 1 -
.../scm/command/changelog/ChangeLogScmResult.java | 1 -
.../maven/scm/command/changelog/ChangeLogSet.java | 21 ++--
.../command/checkin/AbstractCheckInCommand.java | 2 -
.../scm/command/checkin/CheckInScmResult.java | 3 +-
.../command/checkout/AbstractCheckOutCommand.java | 9 +-
.../scm/command/checkout/CheckOutScmResult.java | 3 +-
.../scm/command/diff/AbstractDiffCommand.java | 7 +-
.../maven/scm/command/diff/DiffScmResult.java | 1 -
.../scm/command/edit/AbstractEditCommand.java | 7 +-
.../scm/command/export/AbstractExportCommand.java | 5 +-
.../maven/scm/command/export/ExportScmResult.java | 1 -
.../export/ExportScmResultWithRevision.java | 1 -
.../command/fileinfo/AbstractFileInfoCommand.java | 1 -
.../apache/maven/scm/command/info/InfoItem.java | 6 +-
.../maven/scm/command/info/InfoScmResult.java | 1 -
.../scm/command/list/AbstractListCommand.java | 7 +-
.../maven/scm/command/list/ListScmResult.java | 3 +-
.../scm/command/lock/AbstractLockCommand.java | 1 -
.../scm/command/login/AbstractLoginCommand.java | 5 +-
.../maven/scm/command/login/LoginScmResult.java | 1 -
.../scm/command/mkdir/AbstractMkdirCommand.java | 5 +-
.../maven/scm/command/mkdir/MkdirScmResult.java | 1 -
.../command/remoteinfo/RemoteInfoScmResult.java | 8 +-
.../scm/command/remove/AbstractRemoveCommand.java | 5 +-
.../maven/scm/command/remove/RemoveScmResult.java | 1 -
.../scm/command/status/AbstractStatusCommand.java | 5 +-
.../maven/scm/command/status/StatusScmResult.java | 1 -
.../maven/scm/command/tag/AbstractTagCommand.java | 7 +-
.../apache/maven/scm/command/tag/TagScmResult.java | 1 -
.../scm/command/unedit/AbstractUnEditCommand.java | 7 +-
.../maven/scm/command/unedit/UnEditScmResult.java | 1 -
.../scm/command/unlock/AbstractUnlockCommand.java | 1 -
.../scm/command/untag/AbstractUntagCommand.java | 8 +-
.../maven/scm/command/untag/UntagScmResult.java | 4 +-
.../scm/command/update/AbstractUpdateCommand.java | 5 +-
.../maven/scm/command/update/UpdateScmResult.java | 4 +-
.../update/UpdateScmResultWithRevision.java | 1 -
.../maven/scm/manager/AbstractScmManager.java | 2 +-
.../apache/maven/scm/manager/BasicScmManager.java | 1 -
.../scm/manager/NoSuchScmProviderException.java | 1 -
.../org/apache/maven/scm/manager/ScmManager.java | 104 +++++++++----------
.../maven/scm/provider/AbstractScmProvider.java | 3 +-
.../org/apache/maven/scm/provider/ScmProvider.java | 114 ++++++++++-----------
.../maven/scm/provider/ScmProviderRepository.java | 17 +--
.../provider/ScmProviderRepositoryWithHost.java | 1 -
.../org/apache/maven/scm/provider/ScmUrlUtils.java | 19 ++--
.../apache/maven/scm/repository/ScmRepository.java | 11 +-
.../scm/repository/ScmRepositoryException.java | 1 -
.../scm/repository/UnknownRepositoryStructure.java | 1 -
.../apache/maven/scm/util/AbstractConsumer.java | 5 +-
.../org/apache/maven/scm/util/FilenameUtils.java | 3 -
.../maven/scm/util/ThreadSafeDateFormat.java | 1 +
.../apache/maven/scm/client/cli/MavenScmCli.java | 1 -
.../apache/maven/scm/plugin/AbstractScmMojo.java | 12 ++-
.../java/org/apache/maven/scm/plugin/AddMojo.java | 4 +-
.../org/apache/maven/scm/plugin/BootstrapMojo.java | 6 +-
.../org/apache/maven/scm/plugin/BranchMojo.java | 9 +-
.../org/apache/maven/scm/plugin/ChangeLogMojo.java | 2 +-
.../scm/plugin/CheckLocalModificationsMojo.java | 4 +-
.../org/apache/maven/scm/plugin/CheckinMojo.java | 4 +-
.../org/apache/maven/scm/plugin/CheckoutMojo.java | 8 +-
.../java/org/apache/maven/scm/plugin/DiffMojo.java | 4 +-
.../java/org/apache/maven/scm/plugin/EditMojo.java | 4 +-
.../org/apache/maven/scm/plugin/ExportMojo.java | 4 +-
.../java/org/apache/maven/scm/plugin/ListMojo.java | 4 +-
.../org/apache/maven/scm/plugin/StatusMojo.java | 6 +-
.../java/org/apache/maven/scm/plugin/TagMojo.java | 9 +-
.../org/apache/maven/scm/plugin/UnEditMojo.java | 4 +-
.../org/apache/maven/scm/plugin/UntagMojo.java | 4 +-
.../org/apache/maven/scm/plugin/UpdateMojo.java | 4 +-
.../maven/scm/plugin/UpdateSubprojectsMojo.java | 4 +-
.../org/apache/maven/scm/plugin/ValidateMojo.java | 1 +
.../maven/scm/plugin/ValidateRecursively.java | 2 +-
.../org/apache/maven/scm/provider/hg/HgConfig.java | 7 +-
.../maven/scm/provider/hg/HgScmProvider.java | 69 +++++++++----
.../org/apache/maven/scm/provider/hg/HgUtils.java | 13 +--
.../provider/hg/command/HgCommandConstants.java | 38 +++----
.../maven/scm/provider/hg/command/HgConsumer.java | 13 +--
.../scm/provider/hg/command/add/HgAddCommand.java | 5 +-
.../scm/provider/hg/command/add/HgAddConsumer.java | 5 +-
.../hg/command/branch/HgBranchCommand.java | 1 -
.../hg/command/checkin/HgCheckInCommand.java | 1 -
.../hg/command/checkout/HgCheckOutCommand.java | 1 -
.../hg/command/checkout/HgCheckOutConsumer.java | 5 +-
.../provider/hg/command/diff/HgDiffCommand.java | 5 +-
.../provider/hg/command/diff/HgDiffConsumer.java | 5 +-
.../provider/hg/command/info/HgInfoConsumer.java | 1 -
.../provider/hg/command/inventory/HgChangeSet.java | 3 +-
.../hg/command/inventory/HgListCommand.java | 7 +-
.../hg/command/inventory/HgListConsumer.java | 7 +-
.../hg/command/inventory/HgOutgoingConsumer.java | 3 +-
.../hg/command/remove/HgRemoveCommand.java | 5 +-
.../hg/command/remove/HgRemoveConsumer.java | 5 +-
.../hg/command/status/HgStatusCommand.java | 4 +-
.../hg/command/status/HgStatusConsumer.java | 5 +-
.../scm/provider/hg/command/tag/HgTagCommand.java | 3 +-
.../scm/provider/hg/command/tag/HgTagConsumer.java | 5 +-
.../hg/command/update/HgUpdateCommand.java | 5 +-
.../hg/repository/HgScmProviderRepository.java | 7 +-
.../maven/scm/provider/local/LocalScmProvider.java | 44 ++++++--
.../scm/provider/local/command/LocalCommand.java | 1 -
.../local/command/add/LocalAddCommand.java | 5 +-
.../command/changelog/LocalChangeLogCommand.java | 5 +-
.../local/command/checkin/LocalCheckInCommand.java | 5 +-
.../command/checkout/LocalCheckOutCommand.java | 5 +-
.../command/checkout/LocalCheckOutScmResult.java | 1 -
.../local/command/list/LocalListCommand.java | 5 +-
.../local/command/list/LocalListScmResult.java | 1 -
.../local/command/mkdir/LocalMkdirCommand.java | 1 -
.../local/command/status/LocalStatusCommand.java | 5 +-
.../local/command/tag/LocalTagCommand.java | 9 +-
.../local/command/update/LocalUpdateCommand.java | 9 +-
.../local/command/update/LocalUpdateScmResult.java | 1 -
.../local/metadata/LocalScmMetadataUtils.java | 11 +-
.../repository/LocalScmProviderRepository.java | 5 +-
.../scm/provider/git/AbstractGitScmProvider.java | 84 ++++++++++-----
.../maven/scm/provider/git/GitCommandUtils.java | 1 -
.../scm/provider/git/GitConfigFileReader.java | 3 +-
.../maven/scm/provider/git/command/GitCommand.java | 1 -
.../provider/git/command/diff/GitDiffConsumer.java | 9 +-
.../scm/provider/git/command/info/GitInfoItem.java | 1 -
.../git/command/info/GitInfoScmResult.java | 1 -
.../git/command/update/GitUpdateScmResult.java | 1 -
.../git/repository/GitScmProviderRepository.java | 27 +++--
.../scm/provider/git/repository/RepositoryUrl.java | 14 +--
.../maven/scm/provider/git/util/GitUtil.java | 8 +-
.../scm/provider/git/gitexe/GitExeScmProvider.java | 65 +++++++++---
.../command/AbstractFileCheckingConsumer.java | 5 +-
.../git/gitexe/command/AnonymousCommandLine.java | 3 +-
.../git/gitexe/command/GitCommandLineUtils.java | 1 -
.../git/gitexe/command/blame/GitBlameConsumer.java | 2 +-
.../gitexe/command/branch/GitBranchCommand.java | 7 +-
.../command/branch/GitCurrentBranchConsumer.java | 6 +-
.../command/changelog/GitChangeLogCommand.java | 25 +++--
.../command/changelog/GitChangeLogConsumer.java | 43 ++++----
.../gitexe/command/checkin/GitCheckInCommand.java | 5 +-
.../command/checkout/GitCheckOutCommand.java | 3 +-
.../git/gitexe/command/diff/GitDiffCommand.java | 5 +-
.../gitexe/command/diff/GitDiffRawConsumer.java | 1 -
.../git/gitexe/command/info/GitInfoCommand.java | 3 +-
.../git/gitexe/command/info/GitInfoConsumer.java | 5 +-
.../git/gitexe/command/list/GitListCommand.java | 1 -
.../git/gitexe/command/list/GitListConsumer.java | 5 +-
.../command/remoteinfo/GitRemoteInfoConsumer.java | 4 +-
.../gitexe/command/remove/GitRemoveCommand.java | 1 -
.../gitexe/command/remove/GitRemoveConsumer.java | 3 +-
.../gitexe/command/status/GitStatusCommand.java | 13 +--
.../gitexe/command/status/GitStatusConsumer.java | 22 ++--
.../git/gitexe/command/tag/GitTagCommand.java | 5 +-
.../git/gitexe/command/untag/GitUntagCommand.java | 8 +-
.../update/GitLatestRevisionCommandConsumer.java | 11 +-
.../gitexe/command/update/GitUpdateCommand.java | 11 +-
.../maven/scm/provider/git/GitScmTestUtils.java | 4 +-
.../maven/scm/provider/git/GitSshServer.java | 2 +-
.../command/branch/GitBranchCommandTckTest.java | 5 +-
.../command/branch/GitSshBranchCommandTckTest.java | 11 +-
.../changelog/GitChangeLogCommandTckTest.java | 4 +-
.../command/checkin/GitCheckInCommandTckTest.java | 6 +-
.../checkout/GitCheckOutCommandTckTest.java | 9 +-
.../checkout/GitSshCheckOutCommandTckTest.java | 11 +-
.../git/command/diff/GitDiffCommandTckTest.java | 5 +-
.../git/command/info/GitInfoCommandTckTest.java | 5 +-
.../git/command/list/GitListCommandTckTest.java | 5 +-
.../command/remove/GitRemoveCommandTckTest.java | 8 +-
.../command/status/GitStatusCommandTckTest.java | 5 +-
.../git/command/tag/GitSshTagCommandTckTest.java | 11 +-
.../git/command/tag/GitTagCommandTckTest.java | 5 +-
.../command/untag/GitSshUntagCommandTckTest.java | 11 +-
.../git/command/untag/GitUntagCommandTckTest.java | 8 +-
.../command/update/GitUpdateCommandTckTest.java | 5 +-
.../provider/git/sshd/git/pack/GitPackCommand.java | 8 +-
.../git/sshd/git/pack/GitPackCommandFactory.java | 2 +-
.../scm/provider/git/jgit/command/JGitUtils.java | 29 +++---
.../PlexusInteractivityCredentialsProvider.java | 1 -
.../ScmProviderAwareSshdSessionFactory.java | 1 -
.../git/jgit/command/branch/JGitBranchCommand.java | 2 +-
.../command/changelog/JGitChangeLogCommand.java | 3 -
.../git/jgit/command/untag/JGitUntagCommand.java | 4 +-
.../scm/provider/svn/AbstractSvnScmProvider.java | 3 +-
.../maven/scm/provider/svn/SvnChangeSet.java | 5 +-
.../maven/scm/provider/svn/SvnCommandUtils.java | 1 -
.../scm/provider/svn/SvnConfigFileReader.java | 1 -
.../maven/scm/provider/svn/SvnTagBranchUtils.java | 17 ++-
.../maven/scm/provider/svn/command/SvnCommand.java | 1 -
.../provider/svn/command/diff/SvnDiffConsumer.java | 5 +-
.../scm/provider/svn/command/info/SvnInfoItem.java | 1 -
.../svn/command/info/SvnInfoScmResult.java | 1 -
.../svn/command/update/SvnUpdateScmResult.java | 1 -
.../svn/repository/SvnScmProviderRepository.java | 14 ++-
.../maven/scm/provider/svn/util/SvnUtil.java | 1 -
.../command/AbstractFileCheckingConsumer.java | 5 +-
.../svn/svnexe/command/SvnCommandLineUtils.java | 1 -
.../svn/svnexe/command/add/SvnAddCommand.java | 5 +-
.../svn/svnexe/command/add/SvnAddConsumer.java | 5 +-
.../svnexe/command/branch/SvnBranchCommand.java | 7 +-
.../command/changelog/IllegalOutputException.java | 3 +-
.../command/changelog/SvnChangeLogCommand.java | 9 +-
.../command/changelog/SvnChangeLogConsumer.java | 33 +++---
.../svnexe/command/checkin/SvnCheckInCommand.java | 5 +-
.../svnexe/command/checkin/SvnCheckInConsumer.java | 5 +-
.../command/checkout/SvnCheckOutCommand.java | 7 +-
.../command/checkout/SvnCheckOutConsumer.java | 1 -
.../svn/svnexe/command/diff/SvnDiffCommand.java | 5 +-
.../svnexe/command/export/SvnExeExportCommand.java | 5 +-
.../svn/svnexe/command/info/SvnInfoCommand.java | 5 +-
.../svn/svnexe/command/info/SvnInfoConsumer.java | 5 +-
.../svn/svnexe/command/list/SvnListCommand.java | 5 +-
.../svn/svnexe/command/list/SvnListConsumer.java | 5 +-
.../svn/svnexe/command/mkdir/SvnMkdirCommand.java | 1 -
.../svn/svnexe/command/mkdir/SvnMkdirConsumer.java | 5 +-
.../svnexe/command/remove/SvnRemoveCommand.java | 5 +-
.../svnexe/command/remove/SvnRemoveConsumer.java | 5 +-
.../svnexe/command/status/SvnStatusCommand.java | 5 +-
.../svnexe/command/status/SvnStatusConsumer.java | 5 +-
.../svn/svnexe/command/tag/SvnTagCommand.java | 9 +-
.../svn/svnexe/command/untag/SvnUntagCommand.java | 10 +-
.../svnexe/command/update/SvnUpdateCommand.java | 9 +-
.../svnexe/command/update/SvnUpdateConsumer.java | 5 +-
.../maven/scm/provider/svn/SvnScmTestUtils.java | 5 +-
.../command/branch/SvnBranchCommandTckTest.java | 9 +-
.../command/checkin/SvnCheckInCommandTckTest.java | 9 +-
.../checkout/SvnCheckOutCommandTckTest.java | 9 +-
.../svn/command/diff/SvnDiffCommandTckTest.java | 9 +-
.../svn/command/info/SvnInfoCommandTckTest.java | 8 +-
.../svn/command/list/SvnListCommandTckTest.java | 11 +-
.../svn/command/mkdir/SvnMkdirCommandTckTest.java | 9 +-
.../command/remove/SvnRemoveCommandTckTest.java | 11 +-
.../command/status/SvnStatusCommandTckTest.java | 9 +-
.../svn/command/tag/SvnTagCommandTckTest.java | 9 +-
.../svn/command/untag/SvnUntagCommandTckTest.java | 9 +-
.../command/update/SvnUpdateCommandTckTest.java | 9 +-
.../java/org/apache/maven/scm/ScmTckTestCase.java | 22 ++--
.../java/org/apache/maven/scm/ScmTestCase.java | 7 +-
.../apache/maven/scm/manager/ScmManagerStub.java | 7 +-
.../scm/provider/ScmProviderRepositoryStub.java | 11 +-
.../apache/maven/scm/provider/ScmProviderStub.java | 3 +-
.../maven/scm/repository/ScmRepositoryStub.java | 3 +-
.../tck/command/branch/BranchCommandTckTest.java | 1 -
.../command/changelog/ChangeLogCommandTckTest.java | 3 +-
.../command/checkout/CheckOutCommandTckTest.java | 1 -
.../scm/tck/command/diff/DiffCommandTckTest.java | 1 -
.../scm/tck/command/info/InfoCommandTckTest.java | 1 -
.../scm/tck/command/list/ListCommandTckTest.java | 1 -
.../scm/tck/command/mkdir/MkdirCommandTckTest.java | 1 -
.../tck/command/status/StatusCommandTckTest.java | 1 -
.../scm/tck/command/tag/TagCommandTckTest.java | 1 -
.../tck/command/update/UpdateCommandTckTest.java | 1 -
275 files changed, 1262 insertions(+), 1009 deletions(-)
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/AbstractScmVersion.java b/maven-scm-api/src/main/java/org/apache/maven/scm/AbstractScmVersion.java
index a6d3f786f..4bd6f47f3 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/AbstractScmVersion.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/AbstractScmVersion.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractScmVersion implements ScmVersion, Serializable {
private static final long serialVersionUID = -3388495744009098066L;
@@ -36,12 +35,16 @@ public AbstractScmVersion(String name) {
setName(name);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getName() {
return name;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void setName(String name) {
if (name != null) {
name = name.trim();
@@ -49,7 +52,9 @@ public void setName(String name) {
this.name = name;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return getName();
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeFile.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeFile.java
index 9776c0ae3..e2a168992 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeFile.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ChangeFile.java
@@ -22,46 +22,48 @@
/**
* A set of information about revisions of a file as returned by SCM's log
- * command
+ * command.
*
* @author <a href="mailto:dion@multitask.com.au">dIon Gillard </a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ChangeFile implements Serializable {
private static final long serialVersionUID = 6294855290542668753L;
/**
- * the name of the file relative to the project directory.
+ * The name of the file relative to the project directory.
*/
private String name;
/**
- * the latest revision of the file.
+ * The latest revision of the file.
*/
private String revision;
/**
- * edit type on the file
+ * Edit type on the file
* note: perhaps we should use a different type, ideally enum? this one seems to target quite different usecases ...
+ *
* @since 1.7
*/
private ScmFileStatus action;
/**
- * the name before copying or moving
+ * The name before copying or moving.
+ *
* @since 1.7
*/
private String originalName;
/**
- * the revision from which we {@link ScmFileStatus copied} or {@link ScmFileStatus moved} this file or directory
+ * The revision from which we {@link ScmFileStatus copied} or {@link ScmFileStatus moved} this file or directory.
+ *
* @since 1.7
*/
private String originalRevision;
/**
- * Constructor for the ChangeFile object without all details available
+ * Constructor for the ChangeFile object without all details available.
*
* @param name file name
*/
@@ -70,7 +72,7 @@ public ChangeFile(String name) {
}
/**
- * Constructor for the ChangeFile object
+ * Constructor for the ChangeFile object.
*
* @param name file name
* @param rev latest revision of the file
@@ -93,7 +95,7 @@ public String getName() {
/**
* Setter for property name.
*
- * @param name New value of property name.
+ * @param name new value of property name
*/
public void setName(String name) {
this.name = name;
@@ -128,7 +130,7 @@ public String getRevision() {
/**
* Setter for property revision.
*
- * @param revision New value of property revision.
+ * @param revision new value of property revision
*/
public void setRevision(String revision) {
this.revision = revision;
@@ -143,7 +145,7 @@ public void setAction(ScmFileStatus action) {
}
/**
- * Provide a version of the object as a string for debugging purposes
+ * Provide a version of the object as a string for debugging purposes.
*
* @return a {@link String}made up of the properties of the object
*/
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 af7a0721c..7c8362f12 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
@@ -34,36 +34,32 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ChangeSet implements Serializable {
- /**
- *
- */
private static final long serialVersionUID = 7097705862222539801L;
/**
- * Escaped <code><</code> entity
+ * Escaped <code><</code> entity.
*/
public static final String LESS_THAN_ENTITY = "<";
/**
- * Escaped <code>></code> entity
+ * Escaped <code>></code> entity.
*/
public static final String GREATER_THAN_ENTITY = ">";
/**
- * Escaped <code>&</code> entity
+ * Escaped <code>&</code> entity.
*/
public static final String AMPERSAND_ENTITY = "&";
/**
- * Escaped <code>'</code> entity
+ * Escaped <code>'</code> entity.
*/
public static final String APOSTROPHE_ENTITY = "'";
/**
- * Escaped <code>"</code> entity
+ * Escaped <code>"</code> entity.
*/
public static final String QUOTE_ENTITY = """;
@@ -93,54 +89,57 @@ public class ChangeSet implements Serializable {
private static final ThreadSafeDateFormat TIMESTAMP_FORMAT_4 = new ThreadSafeDateFormat("yyyy-MM-dd HH:mm:ss z");
/**
- * Date the changes were committed
+ * Date the changes were committed.
*/
private Date date;
/**
- * User who made changes
+ * User who made changes.
*/
private String author;
/**
- * comment provided at commit time
+ * Comment provided at commit time.
*/
private String comment = "";
/**
- * List of ChangeFile
+ * List of ChangeFile.
*/
private List<ChangeFile> files;
/**
- * List of tags
+ * List of tags.
*/
private List<String> tags;
/**
* The SCM revision id for this changeset.
+ *
* @since 1.3
*/
private String revision;
/**
- * Revision from which this one originates
+ * Revision from which this one originates.
+ *
* @since 1.7
*/
private String parentRevision;
/**
- * Revisions that were merged into this one
+ * Revisions that were merged into this one.
+ *
* @since 1.7
*/
private Set<String> mergedRevisions;
/**
- * @param strDate Date the changes were committed
+ * @param strDate date the changes were committed
* @param userDatePattern pattern of date
* @param comment comment provided at commit time
- * @param author User who made changes
- * @param files The ChangeFile list
+ * @param author user who made changes
+ * @param files the ChangeFile list
*/
public ChangeSet(String strDate, String userDatePattern, String comment, String author, List<ChangeFile> files) {
this(null, comment, author, files);
@@ -149,10 +148,10 @@ public ChangeSet(String strDate, String userDatePattern, String comment, String
}
/**
- * @param date Date the changes were committed
+ * @param date date the changes were committed
* @param comment comment provided at commit time
- * @param author User who made changes
- * @param files The ChangeFile list
+ * @param author user who made changes
+ * @param files the ChangeFile list
*/
public ChangeSet(Date date, String comment, String author, List<ChangeFile> files) {
setDate(date);
@@ -165,7 +164,7 @@ public ChangeSet(Date date, String comment, String author, List<ChangeFile> file
}
/**
- * Constructor used when attributes aren't available until later
+ * Constructor used when attributes aren't available until later.
*/
public ChangeSet() {
// no op
@@ -174,7 +173,7 @@ public ChangeSet() {
/**
* Getter for ChangeFile list.
*
- * @return List of ChangeFile.
+ * @return list of ChangeFile
*/
public List<ChangeFile> getFiles() {
if (files == null) {
@@ -186,7 +185,7 @@ public List<ChangeFile> getFiles() {
/**
* Setter for ChangeFile list.
*
- * @param files List of ChangeFiles.
+ * @param files list of ChangeFiles
*/
public void setFiles(List<ChangeFile> files) {
this.files = files;
@@ -201,10 +200,10 @@ public void addFile(ChangeFile file) {
}
/**
- * @deprecated Use method {@link #containsFilename(String)}
* @param filename TODO
* @param repository NOT USED
* @return TODO
+ * @deprecated use method {@link #containsFilename(String)}
*/
public boolean containsFilename(String filename, ScmProviderRepository repository) {
return containsFilename(filename);
@@ -227,7 +226,7 @@ public boolean containsFilename(String filename) {
/**
* Getter for property author.
*
- * @return Value of property author.
+ * @return value of property author
*/
public String getAuthor() {
return author;
@@ -236,7 +235,7 @@ public String getAuthor() {
/**
* Setter for property author.
*
- * @param author New value of property author.
+ * @param author new value of property author
*/
public void setAuthor(String author) {
this.author = author;
@@ -245,7 +244,7 @@ public void setAuthor(String author) {
/**
* Getter for property comment.
*
- * @return Value of property comment.
+ * @return value of property comment
*/
public String getComment() {
return comment;
@@ -254,7 +253,7 @@ public String getComment() {
/**
* Setter for property comment.
*
- * @param comment New value of property comment.
+ * @param comment new value of property comment
*/
public void setComment(String comment) {
this.comment = comment;
@@ -263,7 +262,7 @@ public void setComment(String comment) {
/**
* Getter for property date.
*
- * @return Value of property date.
+ * @return value of property date
*/
public Date getDate() {
if (date != null) {
@@ -276,7 +275,7 @@ public Date getDate() {
/**
* Setter for property date.
*
- * @param date New value of property date.
+ * @param date new value of property date
*/
public void setDate(Date date) {
if (date != null) {
@@ -285,19 +284,19 @@ public void setDate(Date date) {
}
/**
- * Setter for property date that takes a string and parses it
+ * Setter for property date that takes a string and parses it.
*
- * @param date - a string in yyyy/MM/dd HH:mm:ss format
+ * @param date a string in yyyy/MM/dd HH:mm:ss format
*/
public void setDate(String date) {
setDate(date, null);
}
/**
- * Setter for property date that takes a string and parses it
+ * Setter for property date that takes a string and parses it.
*
- * @param date - a string in yyyy/MM/dd HH:mm:ss format
- * @param userDatePattern - pattern of date
+ * @param date a string in yyyy/MM/dd HH:mm:ss format
+ * @param userDatePattern pattern of date
*/
public void setDate(String date, String userDatePattern) {
try {
@@ -362,7 +361,7 @@ public String getTimeFormatted() {
/**
* Getter for property tags.
*
- * @return Value of property author.
+ * @return value of property author
*/
public List<String> getTags() {
if (tags == null) {
@@ -374,7 +373,7 @@ public List<String> getTags() {
/**
* Setter for property tags.
*
- * @param tags New value of property tags. This replaces the existing list (if any).
+ * @param tags new value of property tags. This replaces the existing list (if any).
*/
public void setTags(List<String> tags) {
this.tags = tags;
@@ -383,7 +382,7 @@ public void setTags(List<String> tags) {
/**
* Setter for property tags.
*
- * @param tag New tag to add to the list of tags.
+ * @param tag new tag to add to the list of tags
*/
public void addTag(String tag) {
if (tag == null) {
@@ -438,7 +437,9 @@ public void setMergedRevisions(Set<String> mergedRevisions) {
this.mergedRevisions = mergedRevisions;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
StringBuilder result = new StringBuilder(author == null ? " null " : author);
result.append("\n").append(date == null ? "null " : date.toString()).append("\n");
@@ -530,7 +531,9 @@ public String toXML() {
return buffer.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object obj) {
if (obj instanceof ChangeSet) {
ChangeSet changeSet = (ChangeSet) obj;
@@ -543,7 +546,9 @@ public boolean equals(Object obj) {
return false;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
final int prime = 31;
int result = 1;
@@ -557,9 +562,9 @@ public int hashCode() {
}
/**
- * remove a <code>]]></code> from comments (replace it with <code>] ] ></code>).
+ * Remove a <code>]]></code> from comments (replace it with <code>] ] ></code>).
*
- * @param message The message to modify
+ * @param message the message to modify
* @return a clean string
*/
private String removeCDataEnd(String message) {
@@ -575,7 +580,7 @@ private String removeCDataEnd(String message) {
* <p>Escape the <code>toString</code> of the given object.
* For use in an attribute value.</p>
* <p>
- * swiped from jakarta-commons/betwixt -- XMLUtils.java
+ * swiped from jakarta-commons/betwixt -- XMLUtils.java.
*
* @param value escape <code>value.toString()</code>
* @return text with characters restricted (for use in attributes) escaped
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameter.java b/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameter.java
index 3c06bad52..121bb7097 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameter.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameter.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class CommandParameter implements Serializable {
private static final long serialVersionUID = -3391190831054016735L;
@@ -81,14 +80,15 @@ public class CommandParameter implements Serializable {
public static final CommandParameter SCM_SHORT_REVISION_LENGTH = new CommandParameter("shortRevisionLength");
/**
- * Parameter to force add
+ * Parameter to force add.
*
* @since 1.7
*/
public static final CommandParameter FORCE_ADD = new CommandParameter("forceAdd");
/**
- * contains true or false
+ * Contains true or false.
+ *
* @since 1.8
*/
public static final CommandParameter IGNORE_WHITESPACE = new CommandParameter("ignoreWhitespace");
@@ -97,24 +97,25 @@ public class CommandParameter implements Serializable {
* Parameter to indicate whether the commit/tag should be signed or not.
* This is only applicable to Git for now.
* Possible values are outlined in {@link CommandParameters.SignOption}
+ *
* @since 2.2.1
*/
public static final CommandParameter SIGN_OPTION = new CommandParameter("sign");
/**
- * Parameter name
+ * Parameter name.
*/
private String name;
/**
- * @param name The parameter name
+ * @param name the parameter name
*/
private CommandParameter(String name) {
this.name = name;
}
/**
- * @return The parameter name
+ * @return the parameter name
*/
public String getName() {
return name;
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 6a6519f5a..2fa8f2cd1 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
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class CommandParameters implements Serializable {
private static final long serialVersionUID = -7346070735958137283L;
@@ -41,8 +40,8 @@ public class CommandParameters implements Serializable {
/**
* Return the parameter value as String.
*
- * @param parameter The parameter
- * @return The parameter value as a String
+ * @param parameter the parameter
+ * @return the parameter value as a String
* @throws ScmException if the parameter doesn't exist
*/
public String getString(CommandParameter parameter) throws ScmException {
@@ -54,9 +53,9 @@ public String getString(CommandParameter parameter) throws ScmException {
/**
* Return the parameter value or the default value if it doesn't exist.
*
- * @param parameter The parameter
- * @param defaultValue The default value
- * @return The parameter value as a String
+ * @param parameter the parameter
+ * @param defaultValue the default value
+ * @return the parameter value as a String
* @throws ScmException if the value is in the wrong type
*/
public String getString(CommandParameter parameter, String defaultValue) throws ScmException {
@@ -72,8 +71,8 @@ public String getString(CommandParameter parameter, String defaultValue) throws
/**
* Set a parameter value.
*
- * @param parameter The parameter name
- * @param value The value of the parameter
+ * @param parameter the parameter name
+ * @param value the value of the parameter
* @throws ScmException if the parameter already exist
*/
public void setString(CommandParameter parameter, String value) throws ScmException {
@@ -87,8 +86,8 @@ public void setString(CommandParameter parameter, String value) throws ScmExcept
/**
* Return the parameter value as int.
*
- * @param parameter The parameter
- * @return The parameter value as a String
+ * @param parameter the parameter
+ * @return the parameter value as a String
* @throws ScmException if the parameter doesn't exist
*/
public int getInt(CommandParameter parameter) throws ScmException {
@@ -116,8 +115,8 @@ public int getInt(CommandParameter parameter, int defaultValue) throws ScmExcept
/**
* Set a parameter value.
*
- * @param parameter The parameter name
- * @param value The value of the parameter
+ * @param parameter the parameter name
+ * @param value the value of the parameter
* @throws ScmException if the parameter already exist
*/
public void setInt(CommandParameter parameter, int value) throws ScmException {
@@ -131,8 +130,8 @@ public void setInt(CommandParameter parameter, int value) throws ScmException {
/**
* Return the parameter value as Date.
*
- * @param parameter The parameter
- * @return The parameter value as a Date
+ * @param parameter the parameter
+ * @return the parameter value as a Date
* @throws ScmException if the parameter doesn't exist
*/
public Date getDate(CommandParameter parameter) throws ScmException {
@@ -142,9 +141,9 @@ public Date getDate(CommandParameter parameter) throws ScmException {
/**
* Return the parameter value as String or the default value if it doesn't exist.
*
- * @param parameter The parameter
- * @param defaultValue The defaultValue
- * @return The parameter value as a Date
+ * @param parameter the parameter
+ * @param defaultValue the defaultValue
+ * @return the parameter value as a Date
* @throws ScmException if the value is in the wrong type
*/
public Date getDate(CommandParameter parameter, Date defaultValue) throws ScmException {
@@ -154,8 +153,8 @@ public Date getDate(CommandParameter parameter, Date defaultValue) throws ScmExc
/**
* Set a parameter value.
*
- * @param parameter The parameter name
- * @param date The value of the parameter
+ * @param parameter the parameter name
+ * @param date the value of the parameter
* @throws ScmException if the parameter already exist
*/
public void setDate(CommandParameter parameter, Date date) throws ScmException {
@@ -169,8 +168,8 @@ public void setDate(CommandParameter parameter, Date date) throws ScmException {
/**
* Return the parameter value as boolean.
*
- * @param parameter The parameter
- * @return The parameter value as a boolean
+ * @param parameter the parameter
+ * @return the parameter value as a boolean
* @throws ScmException if the parameter doesn't exist
*/
public boolean getBoolean(CommandParameter parameter) throws ScmException {
@@ -180,11 +179,11 @@ public boolean getBoolean(CommandParameter parameter) throws ScmException {
/**
* Return the parameter value as boolean.
*
- * @since 1.7
- * @param parameter The parameter
+ * @param parameter the parameter
* @param defaultValue default value if parameter not exists
- * @return The parameter value as a boolean
+ * @return the parameter value as a boolean
* @throws ScmException if the parameter doesn't exist
+ * @since 1.7
*/
public boolean getBoolean(CommandParameter parameter, boolean defaultValue) throws ScmException {
return Boolean.parseBoolean(getString(parameter, Boolean.toString(defaultValue)));
@@ -197,8 +196,8 @@ public boolean getBoolean(CommandParameter parameter, boolean defaultValue) thro
/**
* Return the parameter value as ScmVersion.
*
- * @param parameter The parameter
- * @return The parameter value as a ScmVersion
+ * @param parameter the parameter
+ * @return the parameter value as a ScmVersion
* @throws ScmException if the parameter doesn't exist
*/
public ScmVersion getScmVersion(CommandParameter parameter) throws ScmException {
@@ -208,9 +207,9 @@ public ScmVersion getScmVersion(CommandParameter parameter) throws ScmException
/**
* Return the parameter value as ScmVersion or the default value.
*
- * @param parameter The parameter
- * @param defaultValue The default value
- * @return The parameter value as a ScmVersion
+ * @param parameter the parameter
+ * @param defaultValue the default value
+ * @return the parameter value as a ScmVersion
* @throws ScmException if the parameter doesn't exist
*/
public ScmVersion getScmVersion(CommandParameter parameter, ScmVersion defaultValue) throws ScmException {
@@ -220,8 +219,8 @@ public ScmVersion getScmVersion(CommandParameter parameter, ScmVersion defaultVa
/**
* Set a parameter value.
*
- * @param parameter The parameter name
- * @param scmVersion The tbranch/tag/revision
+ * @param parameter the parameter name
+ * @param scmVersion the tbranch/tag/revision
* @throws ScmException if the parameter already exist
*/
public void setScmVersion(CommandParameter parameter, ScmVersion scmVersion) throws ScmException {
@@ -276,6 +275,7 @@ public ScmBranchParameters getScmBranchParameters(CommandParameter parameter) th
* <p>
* This is only relevant for SCM providers that support signing commits/tags, such as Git.
* </p>
+ *
* @see <a href="https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work">Git Tools - Signing Your Work</a>
*/
public enum SignOption {
@@ -302,9 +302,9 @@ public void setSignOption(CommandParameter parameter, SignOption signOption) thr
/**
* Return the sign option.
*
- * @param parameter The parameter
- * @return The sign option or null if not set
- * @throws ScmException if the parameter has the wrong type.
+ * @param parameter the parameter
+ * @return the sign option or null if not set
+ * @throws ScmException if the parameter has the wrong type
*/
public SignOption getSignOption(CommandParameter parameter) throws ScmException {
return getObject(SignOption.class, parameter, null);
@@ -317,9 +317,9 @@ public SignOption getSignOption(CommandParameter parameter) throws ScmException
/**
* Return the value object.
*
- * @param clazz The type of the parameter value
- * @param parameter The parameter
- * @return The parameter value
+ * @param clazz the type of the parameter value
+ * @param parameter the parameter
+ * @return the parameter value
* @throws ScmException if the parameter doesn't exist
*/
private <T> T getObject(Class<T> clazz, CommandParameter parameter) throws ScmException {
@@ -335,10 +335,10 @@ private <T> T getObject(Class<T> clazz, CommandParameter parameter) throws ScmEx
/**
* Return the value object or the default value if it doesn't exist.
*
- * @param clazz The type of the parameter value
- * @param parameter The parameter
- * @param defaultValue The defaultValue
- * @return The parameter value
+ * @param clazz the type of the parameter value
+ * @param parameter the parameter
+ * @param defaultValue the defaultValue
+ * @return the parameter value
* @throws ScmException if the defaultValue is in the wrong type
*/
@SuppressWarnings("unchecked")
@@ -360,8 +360,8 @@ private <T> T getObject(Class<T> clazz, CommandParameter parameter, T defaultVal
/**
* Set the parameter value.
*
- * @param parameter The parameter
- * @param value The parameter value
+ * @param parameter the parameter
+ * @param value the parameter value
* @throws ScmException if the parameter already exist
*/
private void setObject(CommandParameter parameter, Object value) throws ScmException {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/NoSuchCommandScmException.java b/maven-scm-api/src/main/java/org/apache/maven/scm/NoSuchCommandScmException.java
index b9e743a0b..880d8eaea 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/NoSuchCommandScmException.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/NoSuchCommandScmException.java
@@ -20,7 +20,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class NoSuchCommandScmException extends ScmException {
@@ -35,7 +34,7 @@ public NoSuchCommandScmException(String commandName) {
/**
* Return the command name.
*
- * @return The command name
+ * @return the command name
*/
public String getCommandName() {
return commandName;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmBranch.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmBranch.java
index 690b3ba3b..99df5c88b 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmBranch.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmBranch.java
@@ -20,12 +20,13 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ScmBranch extends AbstractScmVersion {
private static final long serialVersionUID = 6305050785257168739L;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getType() {
return "Branch";
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmException.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmException.java
index fe188eb92..b3b01003f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmException.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmException.java
@@ -20,7 +20,6 @@
/**
* @author <a href="evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ScmException extends Exception {
static final long serialVersionUID = 5041965569154385323L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
index 04ee15f41..dc6550128 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFile.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class ScmFile implements Comparable<ScmFile>, Serializable {
private static final long serialVersionUID = -9133015730693522690L;
@@ -32,8 +31,8 @@ public class ScmFile implements Comparable<ScmFile>, Serializable {
private ScmFileStatus status;
/**
- * @param path The relative path of the file, should <b>never</b> start with any {@link java.io.File#separator}.
- * @param status The file status
+ * @param path the relative path of the file, should <b>never</b> start with any {@link java.io.File#separator}
+ * @param status the file status
*/
public ScmFile(String path, ScmFileStatus status) {
this.path = path;
@@ -51,7 +50,7 @@ public String getPath() {
}
/**
- * @return The file status
+ * @return the file status
*/
public ScmFileStatus getStatus() {
return status;
@@ -61,7 +60,9 @@ public ScmFileStatus getStatus() {
// Comparable Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public int compareTo(ScmFile other) {
return other.getPath().compareTo(path);
}
@@ -70,7 +71,9 @@ public int compareTo(ScmFile other) {
// Object overrides
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public boolean equals(Object other) {
if (!(other instanceof ScmFile)) {
return false;
@@ -79,12 +82,16 @@ public boolean equals(Object other) {
return ((ScmFile) other).getPath().equals(path);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public int hashCode() {
return path.hashCode();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return "[" + path + ":" + status + "]";
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java
index a6f50a11a..2b14c341f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmFileSet.java
@@ -34,14 +34,15 @@
* Consists of the base directory of the files and a list of files relative to that directory.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class ScmFileSet implements Serializable {
private static final long serialVersionUID = -5978597349974797556L;
private static final String DELIMITER = ",";
- /** @see DirectoryScanner#DEFAULTEXCLUDES */
+ /**
+ * @see DirectoryScanner#DEFAULTEXCLUDES
+ */
private static final String DEFAULT_EXCLUDES = StringUtils.join(DirectoryScanner.DEFAULTEXCLUDES, DELIMITER);
private final File basedir;
@@ -79,9 +80,9 @@ public ScmFileSet(File basedir, File file) {
* using includes and excludes provided.
*
* @param basedir directory files are relative to
- * @param includes Ant pattern for files to include
- * @param excludes Ant pattern for files to exclude,
- * if null DEFAULT_EXCLUDES is used, else DEFAULT_EXCLUDES is added.
+ * @param includes ant pattern for files to include
+ * @param excludes ant pattern for files to exclude,
+ * if null DEFAULT_EXCLUDES is used, else DEFAULT_EXCLUDES is added
* @throws IOException if any
*/
public ScmFileSet(File basedir, String includes, String excludes) throws IOException {
@@ -101,7 +102,7 @@ public ScmFileSet(File basedir, String includes, String excludes) throws IOExcep
* Create a file set with files from basefile, using includes provided and default excludes.
*
* @param basedir directory files are relative to
- * @param includes Ant pattern for files to include
+ * @param includes ant pattern for files to include
* @throws IOException if any
* @since 1.0
*/
@@ -149,7 +150,7 @@ public File getBasedir() {
}
/**
- * Get the list of files in the set, relative to basedir
+ * Get the list of files in the set, relative to basedir.
*
* @return files in this set
* @deprecated use getFileList() instead
@@ -159,9 +160,9 @@ public File[] getFiles() {
}
/**
- * Get the list of files in the set, relative to basedir
+ * Get the list of files in the set, relative to basedir.
*
- * @return List of File objects
+ * @return list of File objects
*/
public List<File> getFileList() {
return this.files;
@@ -181,7 +182,9 @@ public String getExcludes() {
return this.excludes;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return "basedir = " + basedir + "; files = " + files;
}
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 af1f39de1..c22e90b93 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
@@ -32,13 +32,12 @@
* </p>
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public final class ScmFileStatus implements Serializable {
private static final long serialVersionUID = -7840223279162817915L;
/**
- * File is added to the working tree and does not yet exist in the repository
+ * File is added to the working tree and does not yet exist in the repository.
*/
public static final ScmFileStatus ADDED = new ScmFileStatus("added");
@@ -56,12 +55,14 @@ public final class ScmFileStatus implements Serializable {
/**
* The file has been renamed or moved in the working tree.
+ *
* @since 1.7
*/
public static final ScmFileStatus RENAMED = new ScmFileStatus("renamed");
/**
* The file has been copied in the working tree.
+ *
* @since 1.7
*/
public static final ScmFileStatus COPIED = new ScmFileStatus("copied");
@@ -72,12 +73,12 @@ public final class ScmFileStatus implements Serializable {
public static final ScmFileStatus MISSING = new ScmFileStatus("missing");
/**
- * File from working tree is checked into the repository
+ * File from working tree is checked into the repository.
*/
public static final ScmFileStatus CHECKED_IN = new ScmFileStatus("checked-in");
/**
- * File is checked out from the repository and into the working tree
+ * File is checked out from the repository and into the working tree.
*/
public static final ScmFileStatus CHECKED_OUT = new ScmFileStatus("checked-out");
@@ -115,12 +116,12 @@ public final class ScmFileStatus implements Serializable {
/**
* @since 1.5
- * The file is being edited
+ * The file is being edited
*/
public static final ScmFileStatus EDITED = new ScmFileStatus("edit");
/**
- * The status name
+ * The status name.
*/
private final String name;
@@ -128,7 +129,9 @@ private ScmFileStatus(String name) {
this.name = name;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return name;
}
@@ -137,7 +140,7 @@ public String toString() {
* There are changes in the working tree that are not committed to the repository, or <br>
* the file is unknown for the working tree.
*
- * @return true on changes in the working tree or if the file is unknown.
+ * @return true on changes in the working tree or if the file is unknown
*/
public boolean isStatus() {
return this == UNKNOWN || isDiff();
@@ -153,7 +156,7 @@ public boolean isDiff() {
}
/**
- * @return true if the file was part of a transaction with the repository.
+ * @return true if the file was part of a transaction with the repository
*/
public boolean isTransaction() {
return this == CHECKED_IN || this == CHECKED_OUT || this == LOCKED || this == TAGGED || isUpdate();
@@ -166,7 +169,7 @@ public boolean isTransaction() {
* An update indicates the opposite, that the repository was changed compared to
* the working tree and that it is now synchronized unless there are conflicts.
*
- * @return true if the status is conflict, updated or patched.
+ * @return true if the status is conflict, updated or patched
*/
public boolean isUpdate() {
return this == CONFLICT || this == UPDATED || this == PATCHED;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRequest.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRequest.java
index 2ac10a1d8..1879128ae 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRequest.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRequest.java
@@ -70,6 +70,7 @@ public ScmFileSet getScmFileSet() {
/**
* The files being processed. Implementations can also work with all files from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
+ *
* @param scmFileSet working copy and its selected files
*/
public void setScmFileSet(ScmFileSet scmFileSet) {
@@ -79,6 +80,7 @@ public void setScmFileSet(ScmFileSet scmFileSet) {
/**
* Holds all parameter values passed to the implementing part.
* These parameters are usually translated to commandline options or arguments.
+ *
* @return command parameters
*/
public CommandParameters getCommandParameters() {
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 32f6af401..aeed242cd 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
@@ -24,7 +24,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class ScmResult implements Serializable {
private static final long serialVersionUID = 7037918334820621525L;
@@ -46,7 +45,7 @@ public class ScmResult implements Serializable {
* Copy constructor.
* <p>
* Typically used from derived classes when wrapping a ScmResult
- * into a specific type e.g. AddScmResult
+ * into a specific type e.g. AddScmResult.
*
* @param scmResult not null
*/
@@ -63,10 +62,10 @@ public ScmResult(ScmResult scmResult) {
/**
* ScmResult contructor.
*
- * @param commandLine The provider specific command line used
- * @param providerMessage The provider message
- * @param commandOutput The command output of the scm tool
- * @param success True if the command is in success
+ * @param commandLine the provider specific command line used
+ * @param providerMessage the provider message
+ * @param commandOutput the command output of the scm tool
+ * @param success true if the command is in success
*/
public ScmResult(String commandLine, String providerMessage, String commandOutput, boolean success) {
this.commandLine = commandLine;
@@ -79,14 +78,14 @@ public ScmResult(String commandLine, String providerMessage, String commandOutpu
}
/**
- * @return True if the command was in success
+ * @return true if the command was in success
*/
public boolean isSuccess() {
return success;
}
/**
- * @return A message from the provider. On success this would typically be null or
+ * @return a message from the provider. On success this would typically be null or
* an empty string. On failure, it would be the error message from the provider
*/
public String getProviderMessage() {
@@ -94,7 +93,7 @@ public String getProviderMessage() {
}
/**
- * @return Output from Std.Out from the provider during execution
+ * @return output from Std.Out from the provider during execution
* of the command that resulted in this
*/
public String getCommandOutput() {
@@ -102,7 +101,7 @@ public String getCommandOutput() {
}
/**
- * @return The actual provider specific command that resulted in this
+ * @return the actual provider specific command that resulted in this
*/
public String getCommandLine() {
return commandLine;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRevision.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRevision.java
index 9d8983aa0..166a3eef8 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRevision.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmRevision.java
@@ -20,12 +20,13 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ScmRevision extends AbstractScmVersion {
private static final long serialVersionUID = 3831426256650754391L;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getType() {
return "Revision";
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTag.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTag.java
index 3b5be6546..721fc9824 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTag.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTag.java
@@ -20,12 +20,13 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ScmTag extends ScmBranch {
private static final long serialVersionUID = 2286671802987769257L;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getType() {
return "Tag";
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTagParameters.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTagParameters.java
index 1f43423b2..0635f611f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTagParameters.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmTagParameters.java
@@ -72,9 +72,8 @@ public void setPinExternals(boolean pinExternals) {
}
/**
- *
- * @return true if the tag operation should be signed, false otherwise.
- * @deprecated use {@link #getSignOption()} instead.
+ * @return true if the tag operation should be signed, false otherwise
+ * @deprecated use {@link #getSignOption()} instead
*/
@Deprecated
public boolean isSign() {
@@ -83,8 +82,9 @@ public boolean isSign() {
/**
* Set the signing option for the tag operation.
+ *
* @param sign
- * @deprecated use {@link #setSignOption(org.apache.maven.scm.CommandParameters.SignOption)} instead.
+ * @deprecated use {@link #setSignOption(org.apache.maven.scm.CommandParameters.SignOption)} instead
*/
@Deprecated
public void setSign(boolean sign) {
@@ -101,6 +101,7 @@ public void setScmRevision(String scmRevision) {
/**
* Get the signing option for the tag operation.
+ *
* @return the signing option
* @since 2.2.1
*/
@@ -110,6 +111,7 @@ public CommandParameters.SignOption getSignOption() {
/**
* Set the signing option for the tag operation.
+ *
* @param signOption
* @since 2.2.1
*/
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmUntagParameters.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmUntagParameters.java
index 099ce7460..84371d753 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmUntagParameters.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmUntagParameters.java
@@ -21,28 +21,28 @@
import java.io.Serializable;
/**
- * parameters used by implementation to perform untag operation
+ * Parameters used by implementation to perform untag operation.
*
* @since 1.11.2
*/
public class ScmUntagParameters implements Serializable {
/**
- * serial version id
+ * Serial version id.
*/
private static final long serialVersionUID = -7508529445894924957L;
/**
- * id of tag to delete/remove
+ * Id of tag to delete/remove.
*/
private String tag;
/**
- * commit message
+ * Commit message.
*/
private String message;
/**
- * constructor with tag and message
+ * Constructor with tag and message.
*
* @param tag tag id
* @param message commit message
@@ -53,7 +53,7 @@ public ScmUntagParameters(String tag, String message) {
}
/**
- * get tag id
+ * Get tag id.
*
* @return tag id
*/
@@ -62,7 +62,7 @@ public String getTag() {
}
/**
- * set tag id
+ * Set tag id.
*
* @param tag tag id
*/
@@ -71,7 +71,7 @@ public void setTag(String tag) {
}
/**
- * get commit message
+ * Get commit message.
*
* @return commit message
*/
@@ -80,7 +80,7 @@ public String getMessage() {
}
/**
- * set commit message
+ * Set commit message.
*
* @param message commit message
*/
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmVersion.java b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmVersion.java
index 9503c044a..985e94022 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/ScmVersion.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/ScmVersion.java
@@ -20,7 +20,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public interface ScmVersion {
/**
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/AbstractCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/AbstractCommand.java
index cb12be3ca..0bf1990af 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/AbstractCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/AbstractCommand.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractCommand implements Command {
protected Logger logger = LoggerFactory.getLogger(getClass());
@@ -37,7 +36,9 @@ public abstract class AbstractCommand implements Command {
protected abstract ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public final ScmResult execute(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
if (repository == null) {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/Command.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/Command.java
index 7debbf0bd..d51eb42f2 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/Command.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/Command.java
@@ -27,10 +27,9 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public interface Command {
- /** Plexus component key */
+ /** Plexus component key. */
String ROLE = Command.class.getName();
/**
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AbstractAddCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AbstractAddCommand.java
index 8553d6da6..367a5e2be 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AbstractAddCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AbstractAddCommand.java
@@ -28,13 +28,14 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractAddCommand extends AbstractCommand {
protected abstract ScmResult executeAddCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean binary) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
return executeAddCommand(
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AddScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AddScmResult.java
index b05795d2c..705039d0a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AddScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/add/AddScmResult.java
@@ -25,10 +25,9 @@
import org.apache.maven.scm.ScmResult;
/**
- * Result of adding files to the SCM
+ * Result of adding files to the SCM.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class AddScmResult extends ScmResult {
private static final long serialVersionUID = 1L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameLine.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameLine.java
index 9e9a6ebc1..ea5e4ff64 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameLine.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameLine.java
@@ -47,7 +47,6 @@ public BlameLine(Date date, String revision, String author) {
}
/**
- *
* @param date of the commit
* @param revision of the commit
* @param author the person who wrote the line
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameScmRequest.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameScmRequest.java
index 318c6b37e..ca11330c1 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameScmRequest.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/blame/BlameScmRequest.java
@@ -32,7 +32,7 @@ public class BlameScmRequest extends ScmRequest {
private static final long serialVersionUID = 8257038591897128936L;
/**
- * -w option for git
+ * -w option for git.
*/
private boolean ignoreWhitespace;
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 cce5e2532..222e1e23e 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
@@ -31,7 +31,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractBranchCommand extends AbstractCommand {
protected abstract ScmResult executeBranchCommand(
@@ -39,14 +38,15 @@ protected abstract ScmResult executeBranchCommand(
throws ScmException;
/**
- * default impl to provide backward comp
- * @since 1.3
+ * Default impl to provide backward comp.
+ *
* @param repository TODO
* @param fileSet TODO
* @param branchName TODO
* @param scmBranchParameters TODO
* @return TODO
* @throws ScmException if any
+ * @since 1.3
*/
protected ScmResult executeBranchCommand(
ScmProviderRepository repository,
@@ -57,7 +57,9 @@ protected ScmResult executeBranchCommand(
return executeBranchCommand(repository, fileSet, branchName, scmBranchParameters.getMessage());
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
String branchName = parameters.getString(CommandParameter.BRANCH_NAME);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/BranchScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/BranchScmResult.java
index 493d24e76..0c680d413 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/BranchScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/branch/BranchScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class BranchScmResult extends ScmResult {
private static final long serialVersionUID = -4241972929129557932L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java
index 1dd6f01cc..77b422df3 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java
@@ -33,7 +33,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public abstract class AbstractChangeLogCommand extends AbstractCommand implements ChangeLogCommand {
@Deprecated
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogCommand.java
index bb12fc53d..e1245a0bf 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogCommand.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public interface ChangeLogCommand {
ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmResult.java
index 09044459d..2f4bbee4d 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/ChangeLogScmResult.java
@@ -23,7 +23,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class ChangeLogScmResult extends ScmResult {
private static final long serialVersionUID = 559431861541372265L;
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 6f46c8ce3..e124b4986 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
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ChangeLogSet {
public static final String DEFAULT_ENCODING = "ISO-8859-1";
@@ -45,8 +44,8 @@ public class ChangeLogSet {
/**
* Initializes a new instance of this class.
*
- * @param startDate the start date/tag for this set.
- * @param endDate the end date/tag for this set, or <code>null</code> if this set goes to the present time.
+ * @param startDate the start date/tag for this set
+ * @param endDate the end date/tag for this set, or <code>null</code> if this set goes to the present time
*/
public ChangeLogSet(Date startDate, Date endDate) {
this.startDate = startDate;
@@ -56,9 +55,9 @@ public ChangeLogSet(Date startDate, Date endDate) {
/**
* Initializes a new instance of this class.
*
- * @param entries collection of {@link org.apache.maven.scm.ChangeSet} objects for this set.
- * @param startDate the start date/tag for this set.
- * @param endDate the end date/tag for this set, or <code>null</code> if this set goes to the present time.
+ * @param entries collection of {@link org.apache.maven.scm.ChangeSet} objects for this set
+ * @param startDate the start date/tag for this set
+ * @param endDate the end date/tag for this set, or <code>null</code> if this set goes to the present time
*/
public ChangeLogSet(List<ChangeSet> entries, Date startDate, Date endDate) {
this(startDate, endDate);
@@ -68,7 +67,7 @@ public ChangeLogSet(List<ChangeSet> entries, Date startDate, Date endDate) {
/**
* Returns the start date.
*
- * @return the start date.
+ * @return the start date
*/
public Date getStartDate() {
return startDate;
@@ -77,7 +76,7 @@ public Date getStartDate() {
/**
* Returns the end date for this set.
*
- * @return the end date for this set, or <code>null</code> if this set goes to the present time.
+ * @return the end date for this set, or <code>null</code> if this set goes to the present time
*/
public Date getEndDate() {
return endDate;
@@ -86,7 +85,7 @@ public Date getEndDate() {
/**
* Returns the start version (revision/branch/label) for this set.
*
- * @return the start version (revision/branch/label) for this set, or <code>null</code>.
+ * @return the start version (revision/branch/label) for this set, or <code>null</code>
*/
public ScmVersion getStartVersion() {
return startVersion;
@@ -99,7 +98,7 @@ public void setStartVersion(ScmVersion startVersion) {
/**
* Returns the end version (revision/branch/label) for this set.
*
- * @return the end version (revision/branch/label) for this set, or <code>null</code>.
+ * @return the end version (revision/branch/label) for this set, or <code>null</code>
*/
public ScmVersion getEndVersion() {
return endVersion;
@@ -112,7 +111,7 @@ public void setEndVersion(ScmVersion endVersion) {
/**
* Returns the collection of changeSet.
*
- * @return the collection of {@link org.apache.maven.scm.ChangeSet} objects for this set.
+ * @return the collection of {@link org.apache.maven.scm.ChangeSet} objects for this set
*/
public List<ChangeSet> getChangeSets() {
return entries;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/AbstractCheckInCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/AbstractCheckInCommand.java
index f04d4b28a..3c4292cf9 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/AbstractCheckInCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkin/AbstractCheckInCommand.java
@@ -32,7 +32,6 @@
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public abstract class AbstractCheckInCommand extends AbstractCommand {
public static final String NAME = "check-in";
@@ -48,7 +47,6 @@ protected CheckInScmResult executeCheckInCommand(
}
/**
- *
* @param repository
* @param fileSet
* @param message
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 dc90f3a73..ede4f810a 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
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class CheckInScmResult extends ScmResult {
private static final long serialVersionUID = 954225589449445354L;
@@ -72,8 +71,8 @@ public List<ScmFile> getCheckedInFiles() {
}
/**
- * @since 1.2
* @return can be null for some providers (implemented at least for svn)
+ * @since 1.2
*/
public String getScmRevision() {
return scmRevision;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/AbstractCheckOutCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/AbstractCheckOutCommand.java
index 90ce3f40d..7863027a7 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/AbstractCheckOutCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/checkout/AbstractCheckOutCommand.java
@@ -31,7 +31,6 @@
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public abstract class AbstractCheckOutCommand extends AbstractCommand {
/**
@@ -55,8 +54,8 @@ protected CheckOutScmResult executeCheckOutCommand(
* @param repository not null
* @param fileSet not null
* @param scmVersion not null
- * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise.
- * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise.
+ * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise
+ * @param shallow <code>true</code> if shallow check out is wanted, <code>false</code> otherwise
* @return the checkout result
* @throws ScmException if any
* @since 1.1.1
@@ -69,7 +68,9 @@ protected abstract CheckOutScmResult executeCheckOutCommand(
boolean shallow)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
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 a5198c134..d855afdcc 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
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class CheckOutScmResult extends ScmResult {
@@ -104,7 +103,7 @@ public String getRelativePathProjectDirectory() {
* Checked-out revision.
* SCM's that have no revision per repository (or branch) should store <code>null</code> here.
*
- * @return the revision that was checked out.
+ * @return the revision that was checked out
* @since 1.8
*/
public String getRevision() {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/AbstractDiffCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/AbstractDiffCommand.java
index 37d549546..bf3f023c7 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/AbstractDiffCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/AbstractDiffCommand.java
@@ -30,19 +30,20 @@
/**
* TODO: Better support for entire filesets.
* TODO: Better support for entire changesets (ie consistency between revision handling in SVN).
- * TODO: Consistent handling of revisions, tags and dates - currently only revisions supported
+ * TODO: Consistent handling of revisions, tags and dates - currently only revisions supported.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public abstract class AbstractDiffCommand extends AbstractCommand {
protected abstract DiffScmResult executeDiffCommand(
ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion startRevision, ScmVersion endRevision)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
ScmVersion startRevision = parameters.getScmVersion(CommandParameter.START_SCM_VERSION, null);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/DiffScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/DiffScmResult.java
index 0ca17aed6..06a166364 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/DiffScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/diff/DiffScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class DiffScmResult extends ScmResult {
private static final long serialVersionUID = 4036970486972633082L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/edit/AbstractEditCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/edit/AbstractEditCommand.java
index 333de68cf..e1a0d0a74 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/edit/AbstractEditCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/edit/AbstractEditCommand.java
@@ -25,11 +25,10 @@
import org.apache.maven.scm.command.AbstractCommand;
import org.apache.maven.scm.provider.ScmProviderRepository;
-/**
- *
- */
public abstract class AbstractEditCommand extends AbstractCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return executeEditCommand(repository, fileSet);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/AbstractExportCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/AbstractExportCommand.java
index 1de37edec..069d70ad2 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/AbstractExportCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/AbstractExportCommand.java
@@ -29,14 +29,15 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractExportCommand extends AbstractCommand {
protected abstract ExportScmResult executeExportCommand(
ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion, String outputDirectory)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResult.java
index e4da89987..b96bdf367 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ExportScmResult extends ScmResult {
private static final long serialVersionUID = 8564643361304165292L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResultWithRevision.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResultWithRevision.java
index 06d4d1e95..354075cbc 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResultWithRevision.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/export/ExportScmResultWithRevision.java
@@ -24,7 +24,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class ExportScmResultWithRevision extends ExportScmResult {
private static final long serialVersionUID = -7962912849216079039L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/fileinfo/AbstractFileInfoCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/fileinfo/AbstractFileInfoCommand.java
index a3a40bed7..5db0a2919 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/fileinfo/AbstractFileInfoCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/fileinfo/AbstractFileInfoCommand.java
@@ -30,7 +30,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractFileInfoCommand extends AbstractCommand {
protected abstract ScmResult executeFileInfoCommand(
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoItem.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoItem.java
index 4c18c714f..1120d6440 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoItem.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoItem.java
@@ -28,7 +28,6 @@
*
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
* @author Olivier Lamy
- *
* @since 1.5
*/
public class InfoItem {
@@ -127,7 +126,7 @@ public void setLastChangedRevision(String lastChangedRevision) {
}
/**
- * @deprecated Use {@link #getLastChangedDateTime()} instead
+ * @deprecated use {@link #getLastChangedDateTime()} instead
*/
@Deprecated
public String getLastChangedDate() {
@@ -135,7 +134,7 @@ public String getLastChangedDate() {
}
/**
- * @deprecated Use {@link #setLastChangedDateTime(TemporalAccessor)} instead
+ * @deprecated use {@link #setLastChangedDateTime(TemporalAccessor)} instead
*/
@Deprecated
public void setLastChangedDate(String lastChangedDate) {
@@ -143,7 +142,6 @@ public void setLastChangedDate(String lastChangedDate) {
}
/**
- *
* @return the date when the file indicated via {@link #getPath()} has been changed in the SCM for the last time
* @since 2.1.0
*/
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoScmResult.java
index 0c4e963be..b1d32eea3 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/info/InfoScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
* @author Olivier Lamy
- *
*/
public class InfoScmResult extends ScmResult {
private static final long serialVersionUID = 955993340040530451L;
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 ed7cb581e..9a1c0c3ba 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
@@ -29,11 +29,10 @@
/**
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public abstract class AbstractListCommand extends AbstractCommand {
/**
- * List contents of the remote repository
+ * List contents of the remote repository.
*
* @param repository what to list
* @param fileSet the files to list
@@ -46,7 +45,9 @@ protected abstract ListScmResult executeListCommand(
ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
if (fileSet.getFileList().isEmpty()) {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java
index 49086adec..af93bae53 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/list/ListScmResult.java
@@ -26,10 +26,9 @@
/**
* Result of {@link org.apache.maven.scm.provider.ScmProvider#list(org.apache.maven.scm.repository.ScmRepository,
- * org.apache.maven.scm.ScmFileSet, boolean, org.apache.maven.scm.ScmVersion)} operation
+ * org.apache.maven.scm.ScmFileSet, boolean, org.apache.maven.scm.ScmVersion)} operation.
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class ListScmResult extends ScmResult {
private static final long serialVersionUID = 5402161066844465281L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/lock/AbstractLockCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/lock/AbstractLockCommand.java
index 55da4e6a6..26c733629 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/lock/AbstractLockCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/lock/AbstractLockCommand.java
@@ -30,7 +30,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractLockCommand extends AbstractCommand {
protected abstract ScmResult executeLockCommand(
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/AbstractLoginCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/AbstractLoginCommand.java
index 7dac7ee17..98aa8150e 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/AbstractLoginCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/AbstractLoginCommand.java
@@ -27,13 +27,14 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractLoginCommand extends AbstractCommand {
public abstract LoginScmResult executeLoginCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
return executeLoginCommand(repository, fileSet, parameters);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/LoginScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/LoginScmResult.java
index f5d9fc7b1..c01c26b2f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/LoginScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/login/LoginScmResult.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class LoginScmResult extends ScmResult {
private static final long serialVersionUID = -179242524702253809L;
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 e2534b113..1e6dbf16b 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
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public abstract class AbstractMkdirCommand extends AbstractCommand {
/**
@@ -45,7 +44,9 @@ protected abstract MkdirScmResult executeMkdirCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean createInLocal)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
if (fileSet.getFileList().isEmpty()) {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/MkdirScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/MkdirScmResult.java
index 2ea1f26fd..ea47d4d77 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/MkdirScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/mkdir/MkdirScmResult.java
@@ -27,7 +27,6 @@
* Result of making directories in SCM.
*
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public class MkdirScmResult extends ScmResult {
private static final long serialVersionUID = -8717329738246682608L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java
index 7992877b2..bd8028ec5 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remoteinfo/RemoteInfoScmResult.java
@@ -31,14 +31,14 @@ public class RemoteInfoScmResult extends ScmResult {
private static final long serialVersionUID = -5571403202068311222L;
/**
- * depending on scm, information can be different
- * svn: branch name / remote url
+ * Depending on scm, information can be different
+ * svn: branch name / remote url.
*/
private Map<String, String> branches = new HashMap<>();
/**
- * depending on scm, information can be different
- * svn: branch name / remote url
+ * Depending on scm, information can be different
+ * svn: branch name / remote url.
*/
private Map<String, String> tags = new HashMap<>();
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/AbstractRemoveCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/AbstractRemoveCommand.java
index a89c230b3..975c51cf6 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/AbstractRemoveCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/AbstractRemoveCommand.java
@@ -29,13 +29,14 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractRemoveCommand extends AbstractCommand {
protected abstract ScmResult executeRemoveCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
String message = parameters.getString(CommandParameter.MESSAGE);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/RemoveScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/RemoveScmResult.java
index 4685f81e3..c1dd99f3a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/RemoveScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/remove/RemoveScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
*/
public class RemoveScmResult extends ScmResult {
private static final long serialVersionUID = 8852310735079996771L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/AbstractStatusCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/AbstractStatusCommand.java
index 5b48be64f..eb5b6e6c3 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/AbstractStatusCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/AbstractStatusCommand.java
@@ -27,13 +27,14 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public abstract class AbstractStatusCommand extends AbstractCommand {
protected abstract StatusScmResult executeStatusCommand(ScmProviderRepository repository, ScmFileSet fileSet)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return executeStatusCommand(repository, fileSet);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/StatusScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/StatusScmResult.java
index 7985d2294..4a30e001f 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/StatusScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/status/StatusScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class StatusScmResult extends ScmResult {
private static final long serialVersionUID = 7152442589455369403L;
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 177e289d1..340a324c4 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
@@ -31,17 +31,16 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractTagCommand extends AbstractCommand {
/**
- * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)}
* @param repository TODO
* @param fileSet TODO
* @param tagName TODO
* @param message TODO
* @return TODO
* @throws ScmException if any
+ * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)}
*/
protected ScmResult executeTagCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String tagName, String message) throws ScmException {
@@ -52,7 +51,9 @@ protected abstract ScmResult executeTagCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String tagName, ScmTagParameters scmTagParameters)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
String tagName = parameters.getString(CommandParameter.TAG_NAME);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/TagScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/TagScmResult.java
index 9939109c7..9fb6a4fae 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/TagScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/tag/TagScmResult.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class TagScmResult extends ScmResult {
private static final long serialVersionUID = -5068975000282095635L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/AbstractUnEditCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/AbstractUnEditCommand.java
index 929d2ca7d..88492543b 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/AbstractUnEditCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/AbstractUnEditCommand.java
@@ -25,11 +25,10 @@
import org.apache.maven.scm.command.AbstractCommand;
import org.apache.maven.scm.provider.ScmProviderRepository;
-/**
- *
- */
public abstract class AbstractUnEditCommand extends AbstractCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return executeUnEditCommand(repository, fileSet);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/UnEditScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/UnEditScmResult.java
index d029ff777..a619f4d87 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/UnEditScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unedit/UnEditScmResult.java
@@ -25,7 +25,6 @@
/**
* @author Olivier Lamy
- *
*/
public class UnEditScmResult extends ScmResult {
private static final long serialVersionUID = 257465331122587798L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java
index 2801f2a64..20a6b7469 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/unlock/AbstractUnlockCommand.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse </a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractUnlockCommand extends AbstractCommand {
protected abstract ScmResult executeUnlockCommand(ScmProviderRepository repository, File workingDirectory)
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/AbstractUntagCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/AbstractUntagCommand.java
index da9079e56..21aef31af 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/AbstractUntagCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/AbstractUntagCommand.java
@@ -27,10 +27,10 @@
import org.apache.maven.scm.command.AbstractCommand;
import org.apache.maven.scm.provider.ScmProviderRepository;
-/** Removes a tag */
+/** Removes a tag. */
public abstract class AbstractUntagCommand extends AbstractCommand {
/**
- * execute untag command
+ * Execute untag command.
*
* @param repository scm repo
* @param fileSet set of files (unused)
@@ -42,7 +42,9 @@ protected abstract ScmResult executeUntagCommand(
ScmProviderRepository repository, ScmFileSet fileSet, ScmUntagParameters scmUntagParameters)
throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/UntagScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/UntagScmResult.java
index dbbe769c3..9a9f0a9c0 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/UntagScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/UntagScmResult.java
@@ -20,7 +20,9 @@
import org.apache.maven.scm.ScmResult;
-/** {@inheritDoc} */
+/**
+ * {@inheritDoc}
+ */
public class UntagScmResult extends ScmResult {
private static final long serialVersionUID = -5068975000282095635L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/AbstractUpdateCommand.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/AbstractUpdateCommand.java
index 22521b6f3..c252bf157 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/AbstractUpdateCommand.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/AbstractUpdateCommand.java
@@ -39,13 +39,14 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse </a>
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class AbstractUpdateCommand extends AbstractCommand {
protected abstract UpdateScmResult executeUpdateCommand(
ScmProviderRepository repository, ScmFileSet fileSet, ScmVersion scmVersion) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
ScmVersion scmVersion = parameters.getScmVersion(CommandParameter.SCM_VERSION, null);
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResult.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResult.java
index e1d4f0e50..555085b9c 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResult.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResult.java
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class UpdateScmResult extends ScmResult {
private static final long serialVersionUID = -1578149496089492585L;
@@ -55,8 +54,7 @@ public UpdateScmResult(List<ScmFile> updatedFiles, List<ChangeSet> changes, ScmR
}
/**
- *
- * @return List of {@link ScmFile}
+ * @return list of {@link ScmFile}
*/
public List<ScmFile> getUpdatedFiles() {
return updatedFiles;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResultWithRevision.java b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResultWithRevision.java
index 91190e85e..decd735bf 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResultWithRevision.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/command/update/UpdateScmResultWithRevision.java
@@ -28,7 +28,6 @@
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class UpdateScmResultWithRevision extends UpdateScmResult {
private static final long serialVersionUID = 7644079089026359667L;
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 ecae795f2..f58e4053c 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
@@ -183,7 +183,7 @@ public ScmRepository makeScmRepository(String scmUrl) throws ScmRepositoryExcept
}
/**
- * Clean the SCM url by removing all ../ in path
+ * Clean the SCM url by removing all ../ in path.
*
* @param scmUrl the SCM url
* @return the cleaned SCM url
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/BasicScmManager.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/BasicScmManager.java
index 0ab0630e2..4b106dd93 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/BasicScmManager.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/BasicScmManager.java
@@ -20,6 +20,5 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class BasicScmManager extends AbstractScmManager {}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/NoSuchScmProviderException.java b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/NoSuchScmProviderException.java
index bef6757d9..33da4c24a 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/manager/NoSuchScmProviderException.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/manager/NoSuchScmProviderException.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class NoSuchScmProviderException extends ScmException {
static final long serialVersionUID = 4770645185214496323L;
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 ad651c54f..eef11c157 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
@@ -55,7 +55,6 @@
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public interface ScmManager {
// ----------------------------------------------------------------------
@@ -66,9 +65,9 @@ public interface ScmManager {
* Generate a SCMRepository from an SCM URL.
*
* @param scmUrl the scm url
- * @return The scm repository
- * @throws ScmRepositoryException if an error occurs in the scm repository construction
+ * @return the scm repository
* @throws NoSuchScmProviderException if the provider doesn't exist
+ * @throws ScmRepositoryException if an error occurs in the scm repository construction
*/
ScmRepository makeScmRepository(String scmUrl) throws ScmRepositoryException, NoSuchScmProviderException;
@@ -88,10 +87,10 @@ ScmRepository makeProviderScmRepository(String providerType, File path)
/**
* Returns the default provider registered for this providerType or a specific implementation if the
* 'maven.scm.provider.providerType.implementation' system property is defined. For example:
- * maven.scm.provider.git.implementation=git
+ * maven.scm.provider.git.implementation=git.
*
- * @param providerType The provider type (git, svn...)
- * @return The scm provider
+ * @param providerType the provider type (git, svn...)
+ * @return the scm provider
* @throws NoSuchScmProviderException if the provider doesn't exist
*/
ScmProvider getProviderByType(String providerType) throws NoSuchScmProviderException;
@@ -108,28 +107,27 @@ ScmRepository makeProviderScmRepository(String providerType, File path)
void setScmProvider(String providerType, ScmProvider provider);
/**
- * Set the provider implementation
+ * Set the provider implementation.
*
- * @param providerType The provider type, e.g. <code>git</code>
- * @param providerImplementation The provider implementation (the role-hint of the provider), e.g. <code>git</code>,
+ * @param providerType the provider type, e.g. <code>git</code>
+ * @param providerImplementation the provider implementation (the role-hint of the provider), e.g. <code>git</code>,
* <code>svn</code>
*/
void setScmProviderImplementation(String providerType, String providerImplementation);
/**
- * Adds the given files to the source control system
+ * Adds the given files to the source control system.
*
* @param repository the source control system
* @param fileSet the files to be added
* @return an {@link AddScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
* have been added
* @throws ScmException if any
- *
*/
AddScmResult add(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Adds the given files to the source control system
+ * Adds the given files to the source control system.
*
* @param repository the source control system
* @param fileSet the files to be added
@@ -141,7 +139,7 @@ ScmRepository makeProviderScmRepository(String providerType, File path)
AddScmResult add(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException;
/**
- * Branch (or label in some systems) will create a branch of the source file with a certain branch name
+ * Branch (or label in some systems) will create a branch of the source file with a certain branch name.
*
* @param repository the source control system
* @param fileSet the files to branch. Implementations can also give the changes from the
@@ -153,7 +151,7 @@ ScmRepository makeProviderScmRepository(String providerType, File path)
BranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String branchName) throws ScmException;
/**
- * Branch (or label in some systems) will create a branch of the source file with a certain branch name
+ * Branch (or label in some systems) will create a branch of the source file with a certain branch name.
*
* @param repository the source control system
* @param fileSet the files to branch. Implementations can also give the changes from the
@@ -168,7 +166,7 @@ BranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String bran
/**
* Returns the changes that have happend in the source control system in a certain period of time. This can be
- * adding, removing, updating, ... of files
+ * adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes from the
@@ -177,7 +175,7 @@ BranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String bran
* @param endDate the end date of the period
* @param numDays the number days before the current time if startdate and enddate are null
* @param branch the branch/tag
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -188,7 +186,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happend in the source control system in a certain period of time. This can be
- * adding, removing, updating, ... of files
+ * adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes from the
@@ -198,7 +196,7 @@ ChangeLogScmResult changeLog(
* @param numDays the number days before the current time if startdate and enddate are null
* @param branch the branch/tag
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -215,10 +213,10 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happend in the source control system in a certain period of time. This can be
- * adding, removing, updating, ... of files
+ * adding, removing, updating, ... of files.
*
* @param scmRequest request wrapping detailed parameters for the changelog command
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @since 1.8
*/
@@ -226,14 +224,14 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happend in the source control system between two tags. This can be adding,
- * removing, updating, ... of files
+ * removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes from the
* {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param startVersion the start branch/tag/revision
* @param endVersion the end branch/tag/revision
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -244,7 +242,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happend in the source control system between two tags. This can be adding,
- * removing, updating, ... of files
+ * removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes from the
@@ -275,8 +273,8 @@ ChangeLogScmResult changeLog(
* @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 a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
- * have been checked in.
+ * @return a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
+ * have been checked in
* @throws ScmException if any
*/
CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException;
@@ -291,8 +289,8 @@ ChangeLogScmResult changeLog(
* @param repository the source control system
* @param fileSet the files to check in (sometimes called commit)
* @param commandParameters parameters for the command, such as commit message and whether to sign the commit. {@link CommandParameters}
- * @return a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
- * have been checked in.
+ * @return a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
+ * have been checked in
* @throws ScmException if any
*/
CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters commandParameters)
@@ -309,15 +307,15 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandPa
* @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 a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
- * have been checked in.
+ * @return a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
+ * have been checked in
* @throws ScmException if any
*/
CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersion revision, String message)
throws ScmException;
/**
- * Create a copy of the repository on your local machine
+ * Create a copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -327,7 +325,7 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersio
CheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Create a copy of the repository on your local machine
+ * Create a copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -390,7 +388,7 @@ DiffScmResult diff(
EditScmResult edit(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -400,7 +398,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -411,7 +409,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -422,7 +420,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, String outputDirectory) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -461,7 +459,7 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
throws ScmException;
/**
- * Removes the given files from the source control system
+ * Removes the given files from the source control system.
*
* @param repository the source control system
* @param fileSet the files to be removed
@@ -485,7 +483,7 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
StatusScmResult status(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Tag (or label in some systems) will tag the source file with a certain tag
+ * Tag (or label in some systems) will tag the source file with a certain tag.
*
* @param repository the source control system
* @param fileSet the files to tag. Implementations can also give the changes from the
@@ -497,7 +495,7 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName) throws ScmException;
/**
- * Tag (or label in some systems) will tag the source file with a certain tag
+ * Tag (or label in some systems) will tag the source file with a certain tag.
*
* @param repository the source control system
* @param fileSet the files to tag. Implementations can also give the changes from the
@@ -522,7 +520,7 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
UnEditScmResult unedit(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -532,7 +530,7 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -543,23 +541,23 @@ MkdirScmResult mkdir(ScmRepository repository, ScmFileSet fileSet, String messag
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @param runChangelog Run the changelog command after the update
+ * @param runChangelog run the changelog command after the update
* @return TODO
* @throws ScmException if any
*/
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, boolean runChangelog) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @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 runChangelog Run the changelog command after the update
+ * @param runChangelog run the changelog command after the update
* @return TODO
* @throws ScmException if any
*/
@@ -567,7 +565,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -578,7 +576,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String datePattern) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -591,7 +589,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -602,7 +600,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, Date lastUpdate) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -615,11 +613,11 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @param lastUpdate Date of last update
+ * @param lastUpdate date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
* @return TODO
* @throws ScmException if any
@@ -628,12 +626,12 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, Date lastUp
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @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 Date of last update
+ * @param lastUpdate date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
* @return TODO
* @throws ScmException if any
@@ -643,7 +641,7 @@ UpdateScmResult update(
throws ScmException;
/**
- * Returns the blame of specified file
+ * Returns the blame of specified file.
*
* @param repository the source control system
* @param fileSet location of your local copy
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 ea310a0c1..5644d55c2 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
@@ -65,7 +65,6 @@
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public abstract class AbstractScmProvider implements ScmProvider {
protected final Logger logger = LoggerFactory.getLogger(getClass());
@@ -697,7 +696,7 @@ public ListScmResult list(ScmRepository repository, ScmFileSet fileSet, boolean
* @param repository the source control system
* @param fileSet the files to list
* @param parameters TODO
- * @return The list of files in the repository
+ * @return the list of files in the repository
* @throws NoSuchCommandScmException unless overriden by subclass
* @throws ScmException if any
*/
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 c8829022d..97b6540b8 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
@@ -56,7 +56,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public interface ScmProvider {
String getScmType();
@@ -81,9 +80,9 @@ default void setInteractive(boolean interactive) {}
/**
* Validate the scm url.
*
- * @param scmSpecificUrl The SCM url
- * @param delimiter The delimiter used in the SCM url
- * @return Returns a list of messages if the validation failed
+ * @param scmSpecificUrl the SCM url
+ * @param delimiter the delimiter used in the SCM url
+ * @return returns a list of messages if the validation failed
*/
List<String> validateScmUrl(String scmSpecificUrl, char delimiter);
@@ -111,7 +110,7 @@ default void setInteractive(boolean interactive) {}
String sanitizeTagName(String tag);
/**
- * Adds the given files to the source control system
+ * Adds the given files to the source control system.
*
* @param repository the source control system
* @param fileSet the files to be added
@@ -121,7 +120,7 @@ default void setInteractive(boolean interactive) {}
AddScmResult add(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Adds the given files to the source control system
+ * Adds the given files to the source control system.
*
* @param repository the source control system
* @param fileSet the files to be added
@@ -132,7 +131,7 @@ default void setInteractive(boolean interactive) {}
AddScmResult add(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException;
/**
- * Adds the given files to the source control system
+ * Adds the given files to the source control system.
*
* @param repository the source control system
* @param fileSet the files to be added
@@ -144,7 +143,7 @@ AddScmResult add(ScmRepository repository, ScmFileSet fileSet, CommandParameters
throws ScmException;
/**
- * Branch (or label in some systems) will create a branch of the source file with a certain branch name
+ * Branch (or label in some systems) will create a branch of the source file with a certain branch name.
*
* @param repository the source control system
* @param fileSet the files to branch. Implementations can also give the changes
@@ -157,7 +156,7 @@ AddScmResult add(ScmRepository repository, ScmFileSet fileSet, CommandParameters
BranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String branchName) throws ScmException;
/**
- * Branch (or label in some systems) will create a branch of the source file with a certain branch name
+ * Branch (or label in some systems) will create a branch of the source file with a certain branch name.
*
* @param repository the source control system
* @param fileSet the files to branch. Implementations can also give the changes
@@ -173,7 +172,7 @@ BranchScmResult branch(ScmRepository repository, ScmFileSet fileSet, String bran
/**
* Branch (or label in some systems) will create a branch of the source file with a certain
- * branch name
+ * branch name.
*
* @param repository the source control system
* @param fileSet the files to branch. Implementations can also give the changes from the
@@ -190,7 +189,7 @@ BranchScmResult branch(
/**
* Returns the changes that have happened in the source control system in a certain period of time.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -199,7 +198,7 @@ BranchScmResult branch(
* @param endDate the end date of the period
* @param numDays the number days before the current time if startdate and enddate are null
* @param branch the branch/tag name
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#changeLog(org.apache.maven.scm.repository.ScmRepository,
* org.apache.maven.scm.ScmFileSet, java.util.Date, java.util.Date, int,
@@ -211,7 +210,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system in a certain period of time.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -220,7 +219,7 @@ ChangeLogScmResult changeLog(
* @param endDate the end date of the period
* @param numDays the number days before the current time if startdate and enddate are null
* @param branch the branch/tag
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -231,7 +230,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system in a certain period of time.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -241,7 +240,7 @@ ChangeLogScmResult changeLog(
* @param numDays the number days before the current time if startdate and enddate are null
* @param branch the branch/tag name
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -258,7 +257,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system in a certain period of time.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -268,7 +267,7 @@ ChangeLogScmResult changeLog(
* @param numDays the number days before the current time if startDate and endDate are null
* @param branch the branch/tag
* @param datePattern the date pattern use in changelog output returned by scm tool
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -284,10 +283,10 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system in a certain period of time.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param scmRequest request wrapping detailed parameters for the changelog command
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @since 1.8
*/
@@ -295,14 +294,14 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system between two tags.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param startTag the start tag
* @param endTag the end tag
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -312,14 +311,14 @@ ChangeLogScmResult changeLog(ScmRepository repository, ScmFileSet fileSet, Strin
/**
* Returns the changes that have happened in the source control system between two tags.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
* from the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} downwards.
* @param startVersion the start branch/tag/revision
* @param endVersion the end branch/tag/revision
- * @return The SCM result of the changelog command
+ * @return the SCM result of the changelog command
* @throws ScmException if any
* @deprecated use {@link #changeLog(org.apache.maven.scm.command.changelog.ChangeLogScmRequest)} instead
*/
@@ -330,7 +329,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system between two tags.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -349,7 +348,7 @@ ChangeLogScmResult changeLog(
/**
* Returns the changes that have happened in the source control system between two tags.
- * This can be adding, removing, updating, ... of files
+ * This can be adding, removing, updating, ... of files.
*
* @param repository the source control system
* @param fileSet the files to know the changes about. Implementations can also give the changes
@@ -442,7 +441,7 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersio
throws ScmException;
/**
- * Create a copy of the repository on your local machine
+ * Create a copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -455,7 +454,7 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersio
CheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException;
/**
- * Create a copy of the repository on your local machine
+ * Create a copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -465,7 +464,7 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, ScmVersio
CheckOutScmResult checkOut(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Create a copy of the repository on your local machine
+ * Create a copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -565,7 +564,7 @@ DiffScmResult diff(
throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -578,7 +577,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -588,7 +587,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -599,7 +598,7 @@ DiffScmResult diff(
ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -614,7 +613,7 @@ ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, String tag,
throws ScmException;
/**
- * Create an exported copy of the repository on your local machine
+ * Create an exported copy of the repository on your local machine.
*
* @param repository the source control system
* @param fileSet the files are copied to the {@link org.apache.maven.scm.ScmFileSet#getBasedir()} location
@@ -627,7 +626,7 @@ ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Removes the given files from the source control system
+ * Removes the given files from the source control system.
*
* @param repository the source control system
* @param fileSet the files to be removed
@@ -650,7 +649,7 @@ ExportScmResult export(ScmRepository repository, ScmFileSet fileSet, ScmVersion
StatusScmResult status(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Tag (or label in some systems) will tag the source file with a certain tag
+ * Tag (or label in some systems) will tag the source file with a certain tag.
*
* @param repository the source control system
* @param fileSet the files to tag. Implementations can also give the changes
@@ -675,7 +674,7 @@ UntagScmResult untag(ScmRepository repository, ScmFileSet fileSet, CommandParame
throws ScmException;
/**
- * Tag (or label in some systems) will tag the source file with a certain tag
+ * Tag (or label in some systems) will tag the source file with a certain tag.
*
* @param repository the source control system
* @param fileSet the files to tag. Implementations can also give the changes
@@ -689,7 +688,7 @@ UntagScmResult untag(ScmRepository repository, ScmFileSet fileSet, CommandParame
TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, String message) throws ScmException;
/**
- * Tag (or label in some systems) will tag the source file with a certain tag
+ * Tag (or label in some systems) will tag the source file with a certain tag.
*
* @param repository the source control system
* @param fileSet the files to tag. Implementations can also give the changes
@@ -704,7 +703,7 @@ TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, S
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -714,7 +713,7 @@ TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, S
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -727,7 +726,7 @@ TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, S
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -738,12 +737,12 @@ TagScmResult tag(ScmRepository repository, ScmFileSet fileSet, String tagName, S
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion version) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @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
+ * @param runChangelog run the changelog command after the update
* @return TODO
* @throws ScmException if any
* @deprecated you must use {@link ScmProvider#update(org.apache.maven.scm.repository.ScmRepository,
@@ -753,23 +752,23 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag,
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
- * @param runChangelog Run the changelog command after the update
+ * @param runChangelog run the changelog command after the update
* @return TODO
* @throws ScmException if any
*/
UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, boolean runChangelog) throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @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 runChangelog Run the changelog command after the update
+ * @param runChangelog run the changelog command after the update
* @return TODO
* @throws ScmException if any
*/
@@ -777,7 +776,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -792,7 +791,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag,
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -805,7 +804,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -820,7 +819,7 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, String tag,
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -833,12 +832,12 @@ UpdateScmResult update(ScmRepository repository, ScmFileSet fileSet, ScmVersion
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @param repository the source control system
* @param fileSet location of your local copy
* @param tag use the version defined by the tag
- * @param lastUpdate Date of last update
+ * @param lastUpdate date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
* @return TODO
* @throws ScmException if any
@@ -850,12 +849,12 @@ UpdateScmResult update(
throws ScmException;
/**
- * Updates the copy on the local machine with the changes in the repository
+ * Updates the copy on the local machine with the changes in the repository.
*
* @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 Date of last update
+ * @param lastUpdate date of last update
* @param datePattern the date pattern use in changelog output returned by scm tool
* @return TODO
* @throws ScmException if any
@@ -878,7 +877,7 @@ UpdateScmResult update(
/**
* Make a file no longer editable. This is the conterpart of {@link #edit(
- *org.apache.maven.scm.repository.ScmRepository, org.apache.maven.scm.ScmFileSet)}.
+ * org.apache.maven.scm.repository.ScmRepository, org.apache.maven.scm.ScmFileSet)}.
* It makes the file read-only again.
*
* @param repository the source control system
@@ -916,7 +915,7 @@ ListScmResult list(ScmRepository repository, ScmFileSet fileSet, boolean recursi
throws ScmException;
/**
- * Returns the blame of specified file
+ * Returns the blame of specified file.
*
* @param repository the source control system
* @param fileSet location of your local copy
@@ -929,7 +928,6 @@ ListScmResult list(ScmRepository repository, ScmFileSet fileSet, boolean recursi
BlameScmResult blame(ScmRepository repository, ScmFileSet fileSet, String filename) throws ScmException;
/**
- *
* @param blameScmRequest TODO
* @return blame for the file specified in the request
* @throws ScmException if any
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 aa0599dc3..65d445888 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
@@ -22,7 +22,6 @@
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a>
- *
*/
public abstract class ScmProviderRepository {
private String user;
@@ -64,7 +63,7 @@ public abstract class ScmProviderRepository {
private String workItem;
/**
- * @return The user.
+ * @return the user
*/
public String getUser() {
return user;
@@ -73,14 +72,14 @@ public String getUser() {
/**
* Set the user.
*
- * @param user The user
+ * @param user the user
*/
public void setUser(String user) {
this.user = user;
}
/**
- * @return The password.
+ * @return the password
*/
public String getPassword() {
return password;
@@ -89,7 +88,7 @@ public String getPassword() {
/**
* Set the password.
*
- * @param password The user password
+ * @param password the user password
*/
public void setPassword(String password) {
this.password = password;
@@ -100,6 +99,7 @@ public void setPassword(String password) {
* 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
*/
@@ -108,15 +108,15 @@ public boolean isPushChanges() {
}
/**
- * @since 1.4
* @param pushChanges TODO
+ * @since 1.4
*/
public void setPushChanges(boolean pushChanges) {
this.pushChanges = pushChanges;
}
/**
- * @return The workItem.
+ * @return the workItem
* @since 1.9.5
*/
@Deprecated
@@ -127,7 +127,7 @@ public String getWorkItem() {
/**
* Set the workItem.
*
- * @param workItem The workItem.
+ * @param workItem the workItem
* @since 1.9.5
*/
@Deprecated
@@ -147,6 +147,7 @@ public void setWorkItem(String workItem) {
* "maven.scm.persistcheckout" to true.
* <p>
* The default is false. See SCM-113 for more detail.
+ *
* @return TODO
*/
@Deprecated
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryWithHost.java b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryWithHost.java
index 0930117ad..b64923a80 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryWithHost.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryWithHost.java
@@ -20,7 +20,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class ScmProviderRepositoryWithHost extends ScmProviderRepository {
private String host;
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 48235edc7..08da9a61e 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
@@ -31,7 +31,6 @@
* </p>
*
* @author <a href="mailto:dennisl@apache.org">Dennis Lundberg</a>
- *
*/
public abstract class ScmUrlUtils {
private static final String ILLEGAL_SCM_URL =
@@ -41,8 +40,8 @@ public abstract class ScmUrlUtils {
/**
* Get the delimiter used in the scm url.
*
- * @param scmUrl A valid scm url to parse
- * @return The delimiter used in the scm url
+ * @param scmUrl a valid scm url to parse
+ * @return the delimiter used in the scm url
*/
public static String getDelimiter(String scmUrl) {
scmUrl = scmUrl.substring(4);
@@ -63,8 +62,8 @@ public static String getDelimiter(String scmUrl) {
/**
* Get the scm provider from the scm url.
*
- * @param scmUrl A valid scm url to parse
- * @return The scm provider from the scm url
+ * @param scmUrl a valid scm url to parse
+ * @return the scm provider from the scm url
*/
public static String getProvider(String scmUrl) {
String delimiter = getDelimiter(scmUrl);
@@ -79,8 +78,8 @@ public static String getProvider(String scmUrl) {
/**
* Get the provider specific part of the scm url.
*
- * @param scmUrl A valid scm url to parse
- * @return The provider specific part of the scm url
+ * @param scmUrl a valid scm url to parse
+ * @return the provider specific part of the scm url
*/
public static String getProviderSpecificPart(String scmUrl) {
String delimiter = getDelimiter(scmUrl);
@@ -98,7 +97,7 @@ public static String getProviderSpecificPart(String scmUrl) {
* <strong>Note</strong>: does not validate scm provider specific format.
* </p>
*
- * @param scmUrl The scm url to validate
+ * @param scmUrl the scm url to validate
* @return <code>true</code> if the scm url is in the correct format,
* otherwise <code>false</code>
*/
@@ -114,8 +113,8 @@ public static boolean isValid(String scmUrl) {
* <strong>Note</strong>: does not validate scm provider specific format.
* </p>
*
- * @param scmUrl The scm url to validate
- * @return A <code>List</code> that contains the errors that occured
+ * @param scmUrl the scm url to validate
+ * @return a <code>List</code> that contains the errors that occured
*/
public static List<String> validate(String scmUrl) {
List<String> messages = new ArrayList<>();
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 48e427f48..0db4a7ec5 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
@@ -22,14 +22,11 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
* TODO clarify need - should be able to merge with ScmProviderRepository?
*/
public class ScmRepository {
- /** */
private String provider;
- /** */
private ScmProviderRepository providerRepository;
public ScmRepository(String provider, ScmProviderRepository providerRepository) {
@@ -39,20 +36,22 @@ public ScmRepository(String provider, ScmProviderRepository providerRepository)
}
/**
- * @return Returns the provider.
+ * @return returns the provider
*/
public String getProvider() {
return provider;
}
/**
- * @return Returns the provider repository.
+ * @return returns the provider repository
*/
public ScmProviderRepository getProviderRepository() {
return providerRepository;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return provider + ":" + providerRepository;
}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepositoryException.java b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepositoryException.java
index 7ac9c9710..b59325700 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepositoryException.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/ScmRepositoryException.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class ScmRepositoryException extends ScmException {
static final long serialVersionUID = -2191549774722212492L;
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/UnknownRepositoryStructure.java b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/UnknownRepositoryStructure.java
index 1c76aa851..896e73ddc 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/repository/UnknownRepositoryStructure.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/repository/UnknownRepositoryStructure.java
@@ -20,7 +20,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class UnknownRepositoryStructure extends Exception {
private static final long serialVersionUID = -7767277520687595055L;
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 37efa7725..f53f58d51 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
@@ -30,7 +30,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractConsumer implements StreamConsumer {
protected final Logger logger = LoggerFactory.getLogger(getClass());
@@ -41,7 +40,7 @@ public abstract class AbstractConsumer implements StreamConsumer {
* @param date TODO
* @param userPattern TODO
* @param defaultPattern TODO
- * @return A date representing the timestamp of the log entry.
+ * @return a date representing the timestamp of the log entry
*/
protected Date parseDate(String date, String userPattern, String defaultPattern) {
return parseDate(date, userPattern, defaultPattern, null);
@@ -54,7 +53,7 @@ protected Date parseDate(String date, String userPattern, String defaultPattern)
* @param userPattern TODO
* @param defaultPattern TODO
* @param locale TODO
- * @return A date representing the timestamp of the log entry.
+ * @return a date representing the timestamp of the log entry
*/
protected Date parseDate(String date, String userPattern, String defaultPattern, Locale locale) {
DateFormat format;
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 89bffb5fc..c32e2dbd6 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
@@ -22,9 +22,6 @@
import org.apache.commons.lang3.StringUtils;
-/**
- *
- */
public final class FilenameUtils {
private FilenameUtils() {}
diff --git a/maven-scm-api/src/main/java/org/apache/maven/scm/util/ThreadSafeDateFormat.java b/maven-scm-api/src/main/java/org/apache/maven/scm/util/ThreadSafeDateFormat.java
index 3215795b1..e83b58630 100644
--- a/maven-scm-api/src/main/java/org/apache/maven/scm/util/ThreadSafeDateFormat.java
+++ b/maven-scm-api/src/main/java/org/apache/maven/scm/util/ThreadSafeDateFormat.java
@@ -28,6 +28,7 @@
/**
* Thread-safe version of java.text.DateFormat.
* You can declare it as a static final variable:
+ *
* @author Olivier Lamy
* <code>
* private static final ThreadSafeDateFormat DATE_FORMAT = new ThreadSafeDateFormat( DATE_PATTERN );
diff --git a/maven-scm-client/src/main/java/org/apache/maven/scm/client/cli/MavenScmCli.java b/maven-scm-client/src/main/java/org/apache/maven/scm/client/cli/MavenScmCli.java
index 37897d6a6..825e7b079 100644
--- a/maven-scm-client/src/main/java/org/apache/maven/scm/client/cli/MavenScmCli.java
+++ b/maven-scm-client/src/main/java/org/apache/maven/scm/client/cli/MavenScmCli.java
@@ -48,7 +48,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class MavenScmCli {
private PlexusContainer plexus;
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
index 2c356990a..cb7f8f092 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
@@ -95,6 +95,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
/**
* The user name.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html">Authentication</a>
*/
@Parameter(property = "username")
@@ -102,6 +103,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
/**
* The user password.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html">Authentication</a>
*/
@Parameter(property = "password")
@@ -109,6 +111,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
/**
* The private key.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html">Authentication</a>
*/
@Parameter(property = "privateKey")
@@ -116,6 +119,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
/**
* The passphrase.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html">Authentication</a>
*/
@Parameter(property = "passphrase")
@@ -129,6 +133,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
* Currently the POM does not allow to specify a server id for the SCM section.
* <p>
* Explicit authentication information provided via {@link #username}, {@link #password} or {@link #privateKey} will take precedence.
+ *
* @see <a href="https://maven.apache.org/scm/authentication.html">Authentication</a>
* @since 2.2.0
*/
@@ -173,6 +178,7 @@ public abstract class AbstractScmMojo extends AbstractMojo {
/**
* List of remapped provider implementations. Allows to bind a different implementation than the default one to a provider id.
* The key is the remapped provider id, the value is the default provider id the implementation is bound to.
+ *
* @see <a href="https://maven.apache.org/scm/scms-overview.html">Supported SCMs</a>
*/
@Parameter
@@ -208,7 +214,9 @@ protected AbstractScmMojo(ScmManager manager, SettingsDecrypter settingsDecrypte
this.settingsDecrypter = settingsDecrypter;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
if (systemProperties != null) {
// Add all system properties configured by the user
@@ -350,7 +358,7 @@ public ScmRepository getScmRepository() throws ScmException {
}
/**
- * Load username password from settings if user has not set them in JVM properties
+ * Load username password from settings if user has not set them in JVM properties.
*
* @param repo not null
*/
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AddMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AddMojo.java
index 0980401dd..a2a4692ac 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AddMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AddMojo.java
@@ -43,7 +43,9 @@ public AddMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
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 6cd7d9c39..540505b46 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
@@ -69,7 +69,7 @@ public class BootstrapMojo extends CheckoutMojo {
private String goalsDirectory;
/**
- * The path where your maven is installed
+ * The path where your maven is installed.
*/
@Parameter(property = "mavenHome", defaultValue = "${maven.home}")
private File mavenHome;
@@ -79,7 +79,9 @@ public BootstrapMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BranchMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BranchMojo.java
index 855df16f3..2af84ad5f 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BranchMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BranchMojo.java
@@ -53,7 +53,7 @@ public class BranchMojo extends AbstractScmMojo {
private String message;
/**
- * currently only implemented with svn scm. Enable a workaround to prevent issue
+ * Currently only implemented with svn scm. Enable a workaround to prevent issue
* due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
*
* @since 1.3
@@ -65,9 +65,8 @@ public class BranchMojo extends AbstractScmMojo {
* Currently only implemented with Subversion. Enable the "--pin-externals"
* option in svn copy commands which is new in Subversion 1.9.
*
- * @since 1.11.0
- *
* @see https://subversion.apache.org/docs/release-notes/1.9.html
+ * @since 1.11.0
*/
@Parameter(property = "pinExternals", defaultValue = "false")
private boolean pinExternals;
@@ -77,7 +76,9 @@ public BranchMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
index 0d84d4971..7d0fc714b 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
@@ -212,7 +212,7 @@ public void execute() throws MojoExecutionException {
/**
* Converts the localized date string pattern to date object.
*
- * @return A date
+ * @return a date
*/
private Date parseDate(SimpleDateFormat format, String date) throws MojoExecutionException {
if (date == null || date.trim().length() == 0) {
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckLocalModificationsMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckLocalModificationsMojo.java
index 0e6a62602..ecce23446 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckLocalModificationsMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckLocalModificationsMojo.java
@@ -32,7 +32,7 @@
import org.apache.maven.settings.crypto.SettingsDecrypter;
/**
- * This mojo will fail the build if there is any local modifications
+ * This mojo will fail the build if there is any local modifications.
*
* @author Olivier Lamy
* @since 1.2
@@ -41,7 +41,7 @@
public class CheckLocalModificationsMojo extends AbstractScmMojo {
/**
- * Custom error message
+ * Custom error message.
*/
@Parameter(
property = "scm.checkLocalModification.errorMessage",
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
index 901e10fd7..40bb10eb0 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
@@ -79,7 +79,9 @@ public CheckinMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
index ef279080f..323581ce5 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
@@ -44,7 +44,7 @@
@Mojo(name = "checkout", requiresProject = false)
public class CheckoutMojo extends AbstractScmMojo {
/**
- * Use Export instead of checkout
+ * Use Export instead of checkout.
*/
@Parameter(property = "useExport", defaultValue = "false")
private boolean useExport;
@@ -82,7 +82,7 @@ public class CheckoutMojo extends AbstractScmMojo {
private boolean shallow = false;
/**
- * allow extended mojo (ie BootStrap ) to see checkout result
+ * Allow extended mojo (ie BootStrap ) to see checkout result.
*/
private ScmResult checkoutResult;
@@ -91,7 +91,9 @@ public CheckoutMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
index 439a23a81..6298c899b 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
@@ -75,7 +75,9 @@ public DiffMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
index 29b695a7c..cbd853637 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
@@ -43,7 +43,9 @@ public EditMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ExportMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ExportMojo.java
index ea8a1b5fb..a701f8251 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ExportMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ExportMojo.java
@@ -70,7 +70,9 @@ public ExportMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ListMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ListMojo.java
index 7c7423c35..69321d9b2 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ListMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ListMojo.java
@@ -62,7 +62,9 @@ public ListMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
index 4453450f8..2c5b4a497 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
@@ -47,7 +47,9 @@ public StatusMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
@@ -82,7 +84,7 @@ public void execute() throws MojoExecutionException {
*
* @param baseDir
* @param path
- * @return The relative path
+ * @return the relative path
*/
protected String getRelativePath(File baseDir, String path) {
if (path.equals(baseDir.getAbsolutePath())) {
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
index b05bac4c8..988aa1cbf 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
@@ -81,7 +81,7 @@ public class TagMojo extends AbstractScmMojo {
private String timestampPrefix;
/**
- * currently only implemented with svn scm. Enable a workaround to prevent issue
+ * Currently only implemented with svn scm. Enable a workaround to prevent issue
* due to svn client > 1.5.0 (https://issues.apache.org/jira/browse/SCM-406)
*
* @since 1.2
@@ -93,9 +93,8 @@ public class TagMojo extends AbstractScmMojo {
* Currently only implemented with Subversion. Enable the "--pin-externals"
* option in svn copy commands which is new in Subversion 1.9.
*
- * @since 1.11.0
- *
* @see https://subversion.apache.org/docs/release-notes/1.9.html
+ * @since 1.11.0
*/
@Parameter(property = "pinExternals", defaultValue = "false")
private boolean pinExternals;
@@ -123,7 +122,9 @@ public TagMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
index 55e625e5e..76e9cb8ba 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
@@ -43,7 +43,9 @@ public UnEditMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UntagMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UntagMojo.java
index 819182ced..51bb6bb32 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UntagMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UntagMojo.java
@@ -56,7 +56,9 @@ public UntagMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
index 723d86cd3..6f574d495 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
@@ -75,7 +75,9 @@ public UpdateMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateSubprojectsMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateSubprojectsMojo.java
index 722fa9112..7b22150cf 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateSubprojectsMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateSubprojectsMojo.java
@@ -68,7 +68,9 @@ public UpdateSubprojectsMojo(ScmManager manager, SettingsDecrypter settingsDecry
super(manager, settingsDecrypter);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void execute() throws MojoExecutionException {
super.execute();
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
index 2ce62bfe0..2b0868c18 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
@@ -60,6 +60,7 @@ public class ValidateMojo extends AbstractScmMojo {
/**
* <em>(Subversion specific)</em> Enables checking that "URL" field returned by 'svn info' matches what is
* specified under the scm tag.
+ *
* @see AbstractSvnScmProvider#CURRENT_WORKING_DIRECTORY
*/
@Parameter(property = "scmCheckWorkingDirectoryUrl", defaultValue = "false")
diff --git a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateRecursively.java b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateRecursively.java
index b30deafad..059b14f71 100644
--- a/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateRecursively.java
+++ b/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateRecursively.java
@@ -27,7 +27,7 @@
import org.apache.maven.settings.crypto.SettingsDecrypter;
/**
- * Validate scm connection string recursively for all projects
+ * Validate scm connection string recursively for all projects.
*/
@Mojo(name = "validate-recursively", requiresProject = true)
@Execute(phase = LifecyclePhase.VALIDATE)
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgConfig.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgConfig.java
index 64177710d..0a93cf68d 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgConfig.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgConfig.java
@@ -31,7 +31,6 @@
*
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author <a href="mailto:ryan@darksleep.com">ryan daum</a>
- *
*/
public class HgConfig {
// Minimum version for the Hg SCM
@@ -56,14 +55,14 @@ public class HgConfig {
}
/**
- * @return True if one can run basic hg commands
+ * @return true if one can run basic hg commands
*/
private boolean isInstalled() {
return hgVersion.isVersionOk(HG_REQ);
}
/**
- * @return True if all modules for hg are installed.
+ * @return true if all modules for hg are installed
*/
private boolean isComplete() {
return isInstalled();
@@ -84,7 +83,7 @@ public static HgVersionConsumer getHgVersion(File workingDir) throws ScmExceptio
/**
* Iterate through two dot-notation version strings, normalize them to the same length, then
- * do alphabetic comparison
+ * do alphabetic comparison.
*
* @param version1
* @param version2
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgScmProvider.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgScmProvider.java
index 836c6d5a0..e27378a9a 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgScmProvider.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/HgScmProvider.java
@@ -68,7 +68,9 @@
@Singleton
@Named("hg")
public class HgScmProvider extends AbstractScmProvider {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmSpecificFilename() {
return ".hg";
}
@@ -79,7 +81,9 @@ private static class HgUrlParserResult {
private ScmProviderRepository repository;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, char delimiter)
throws ScmRepositoryException {
HgUrlParserResult result = parseScmUrl(scmSpecificUrl);
@@ -131,7 +135,9 @@ private HgUrlParserResult parseScmUrl(String scmSpecificUrl) {
return result;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmProviderRepository makeProviderScmRepository(File path)
throws ScmRepositoryException, UnknownRepositoryStructure {
if (path == null) {
@@ -151,19 +157,25 @@ public ScmProviderRepository makeProviderScmRepository(File path)
return makeProviderScmRepository(path.getAbsolutePath(), ':');
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public List<String> validateScmUrl(String scmSpecificUrl, char delimiter) {
HgUrlParserResult result = parseScmUrl(scmSpecificUrl);
return result.messages;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmType() {
return "hg";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgAddCommand command = new HgAddCommand();
@@ -171,7 +183,9 @@ public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, Co
return (AddScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ChangeLogScmResult changelog(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
HgChangeLogCommand command = new HgChangeLogCommand();
@@ -179,7 +193,9 @@ public ChangeLogScmResult changelog(
return (ChangeLogScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgCheckInCommand command = new HgCheckInCommand();
@@ -187,7 +203,9 @@ public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fil
return (CheckInScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public CheckOutScmResult checkout(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
HgCheckOutCommand command = new HgCheckOutCommand();
@@ -195,7 +213,9 @@ public CheckOutScmResult checkout(
return (CheckOutScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgTagCommand command = new HgTagCommand();
@@ -203,7 +223,9 @@ public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, Co
return (TagScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgDiffCommand command = new HgDiffCommand();
@@ -211,7 +233,9 @@ public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet,
return (DiffScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgRemoveCommand command = new HgRemoveCommand();
@@ -219,7 +243,9 @@ public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileS
return (RemoveScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgStatusCommand command = new HgStatusCommand();
@@ -227,7 +253,9 @@ public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileS
return (StatusScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgUpdateCommand command = new HgUpdateCommand();
@@ -235,7 +263,9 @@ public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileS
return (UpdateScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected BlameScmResult blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgBlameCommand command = new HgBlameCommand();
@@ -243,7 +273,9 @@ protected BlameScmResult blame(ScmProviderRepository repository, ScmFileSet file
return (BlameScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public BranchScmResult branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
HgBranchCommand command = new HgBranchCommand();
@@ -263,9 +295,10 @@ protected ListScmResult list(ScmProviderRepository repository, ScmFileSet fileSe
}
/**
- * returns result of hg id -i
- * @since 1.5
+ * Returns result of hg id -i.
+ *
* @see org.apache.maven.scm.provider.AbstractScmProvider#info(org.apache.maven.scm.provider.ScmProviderRepository, org.apache.maven.scm.ScmFileSet, org.apache.maven.scm.CommandParameters)
+ * @since 1.5
*/
@Override
public InfoScmResult info(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
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 fb91ac817..a03197df8 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
@@ -42,7 +42,6 @@
* Common code for executing hg commands.
*
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public final class HgUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(HgUtils.class);
@@ -54,16 +53,16 @@ private HgUtils() {
}
/**
- * Map between command and its valid exit codes
+ * Map between command and its valid exit codes.
*/
private static final Map<String, List<Integer>> EXIT_CODE_MAP = new HashMap<>();
/**
- * Default exit codes for entries not in exitCodeMap
+ * Default exit codes for entries not in exitCodeMap.
*/
private static final List<Integer> DEFAULT_EXIT_CODES = new ArrayList<>();
- /** Setup exit codes*/
+ /** Setup exit codes. */
static {
DEFAULT_EXIT_CODES.add(Integer.valueOf(0));
@@ -218,7 +217,7 @@ int getCurrentRevisionNumber() {
}
/**
- * Get current (working) branch name
+ * Get current (working) branch name.
*/
private static class HgBranchnameConsumer extends HgConsumer {
@@ -232,7 +231,9 @@ String getBranchName() {
return branchName;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (logger.isDebugEnabled()) {
logger.debug(line);
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 741480cf1..590639374 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
@@ -33,32 +33,32 @@ private HgCommandConstants() {
}
/**
- * Executable for Hg
+ * Executable for Hg.
*/
public static final String EXEC = "hg";
/**
- * Use to create an empty branch or before importing an existing project
+ * Use to create an empty branch or before importing an existing project.
*/
public static final String INIT_CMD = "init";
/**
- * Default recursive. Common option: --dry-run and --no-recursive
+ * Default recursive. Common option: --dry-run and --no-recursive.
*/
public static final String ADD_CMD = "add";
/**
- * Reports the following states: added, removed, modified, unchanged, unknown
+ * Reports the following states: added, removed, modified, unchanged, unknown.
*/
public static final String STATUS_CMD = "status";
/**
- * Make a file unversioned
+ * Make a file unversioned.
*/
public static final String REMOVE_CMD = "remove";
/**
- * Create a new copy of a branch. Alias get or clone
+ * Create a new copy of a branch. Alias get or clone.
*/
public static final String CLONE_CMD = "clone";
@@ -68,62 +68,62 @@ private HgCommandConstants() {
public static final String BRANCH_CMD = "branch";
/**
- * Commit changes into a new revision
+ * Commit changes into a new revision.
*/
public static final String COMMIT_CMD = "commit";
/**
- * update working-copy to tip
+ * Update working-copy to tip.
*/
public static final String UPDATE_CMD = "update";
/**
- * Pull any changes from another branch into the current one
+ * Pull any changes from another branch into the current one.
*/
public static final String PULL_CMD = "pull";
/**
- * Show log of this branch Common option: --revision
+ * Show log of this branch Common option: --revision.
*/
public static final String LOG_CMD = "log";
/**
- * Show differences in workingtree. Common option: --revision
+ * Show differences in workingtree. Common option: --revision.
*/
public static final String DIFF_CMD = "diff";
/**
- * Push this branch into another branch
+ * Push this branch into another branch.
*/
public static final String PUSH_CMD = "push";
/**
- * Show current revision number
+ * Show current revision number.
*/
public static final String REVNO_CMD = "id";
/**
- * Tag this revision
+ * Tag this revision.
*/
public static final String TAG_CMD = "tag";
/**
- * Show list of the current working copy or a revision
+ * Show list of the current working copy or a revision.
*/
public static final String INVENTORY_CMD = "locate";
/**
- * Outgoing changes command
+ * Outgoing changes command.
*/
public static final String OUTGOING_CMD = "outgoing";
/**
- * Named branch command
+ * Named branch command.
*/
public static final String BRANCH_NAME_CMD = "branch";
/**
- * no recurse option does not exist in mercurial
+ * No recurse option does not exist in mercurial.
*/
public static final String NO_RECURSE_OPTION = "";
@@ -150,7 +150,7 @@ private HgCommandConstants() {
public static final String TEMPLATE_OPTION = "--template";
/**
- * limit number of changes displayed
+ * Limit number of changes displayed.
*/
public static final String LIMIT_OPTION = "--limit";
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 b1648808d..1971dd70b 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,20 +31,19 @@
* Base consumer to do common parsing for all hg commands.
* <p>
* More specific: log line each line if debug is enabled, get file status
- * and detect warnings from hg
+ * and detect warnings from hg.
*
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgConsumer extends AbstractConsumer {
/**
- * A list of known keywords from hg
+ * A list of known keywords from hg.
*/
private static final Map<String, ScmFileStatus> IDENTIFIERS = new HashMap<>();
/**
- * A list of known message prefixes from hg
+ * A list of known message prefixes from hg.
*/
private static final Map<String, String> MESSAGES = new HashMap<>();
@@ -88,7 +87,9 @@ public void doConsume(ScmFileStatus status, String trimmedLine) {
// override this
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (logger.isDebugEnabled()) {
logger.debug(line);
@@ -118,7 +119,7 @@ public void consumeLine(String line) {
* Warnings and errors is usually printed out in Std.Err, thus for derived consumers
* operating on Std.Out this would typically return an empty string.
*
- * @return Return the last lines interpreted as an warning or an error
+ * @return return the last lines interpreted as an warning or an error
*/
public String getStdErr() {
StringBuilder str = new StringBuilder();
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddCommand.java
index 22f722a02..7b10c9f96 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddCommand.java
@@ -36,10 +36,11 @@
* Add no recursive.
*
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgAddCommand extends AbstractAddCommand implements Command {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeAddCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String message, boolean binary) throws ScmException {
// String[] addCmd = new String[] { ADD_CMD, NO_RECURSE_OPTION };
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddConsumer.java
index af1acd65c..95faa733d 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/add/HgAddConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgAddConsumer extends HgConsumer {
private final File workingDir;
@@ -39,7 +38,9 @@ public HgAddConsumer(File workingDir) {
this.workingDir = workingDir;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String trimmedLine) {
if (status == ScmFileStatus.ADDED) {
// Only include real files (not directories)
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/branch/HgBranchCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/branch/HgBranchCommand.java
index d857d16a7..1d43ae8b7 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/branch/HgBranchCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/branch/HgBranchCommand.java
@@ -44,7 +44,6 @@
* the branch does not exist (yet) in the repository.
*
* @author Henning Schmiedehausen
- *
*/
public class HgBranchCommand extends AbstractBranchCommand implements Command {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkin/HgCheckInCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkin/HgCheckInCommand.java
index 842f8df5f..2b5a15d15 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkin/HgCheckInCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkin/HgCheckInCommand.java
@@ -42,7 +42,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgCheckInCommand extends AbstractCheckInCommand {
/**
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutCommand.java
index ae237748b..64069d870 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutCommand.java
@@ -41,7 +41,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgCheckOutCommand extends AbstractCheckOutCommand implements Command {
/**
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutConsumer.java
index 3b0c9514d..f792ec226 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/checkout/HgCheckOutConsumer.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgCheckOutConsumer extends HgConsumer {
@@ -41,7 +40,9 @@ public HgCheckOutConsumer(File workingDirectory) {
this.workingDirectory = workingDirectory;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String line) {
File file = new File(workingDirectory, line);
if (file.isFile()) {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffCommand.java
index e3ab4825f..b0fce37e4 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffCommand.java
@@ -32,10 +32,11 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgDiffCommand extends AbstractDiffCommand implements Command {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected DiffScmResult executeDiffCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion startRevision, ScmVersion endRevision)
throws ScmException {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffConsumer.java
index bb65a68a2..a5b1812b3 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/diff/HgDiffConsumer.java
@@ -31,7 +31,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgDiffConsumer extends HgConsumer {
@@ -78,7 +77,9 @@ public HgDiffConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (line.startsWith(INDEX_TOKEN)) {
// start a new file
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/info/HgInfoConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/info/HgInfoConsumer.java
index 8142ae1b1..fd3aed8b5 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/info/HgInfoConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/info/HgInfoConsumer.java
@@ -27,7 +27,6 @@
/**
* @author Olivier Lamy
* @since 1.5
- *
*/
public class HgInfoConsumer extends HgConsumer {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgChangeSet.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgChangeSet.java
index 7a548985d..e3cb5f0e8 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgChangeSet.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgChangeSet.java
@@ -21,10 +21,9 @@
import org.apache.maven.scm.ChangeSet;
/**
- * Mercurial changeset
+ * Mercurial changeset.
*
* @author <a href="mailto:lperez@xebia.fr">Laurent Perez</a>
- *
*/
public class HgChangeSet extends ChangeSet {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListCommand.java
index 2c11233d7..3db61a176 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListCommand.java
@@ -32,13 +32,14 @@
import org.apache.maven.scm.provider.hg.command.HgCommandConstants;
/**
- * Get a list of all files in the repository
+ * Get a list of all files in the repository.
*
* @author <a href="mailto:ryan@darksleep.com">ryan daum</a>
- *
*/
public class HgListCommand extends AbstractListCommand implements Command {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ListScmResult executeListCommand(
ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion scmVersion)
throws ScmException {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListConsumer.java
index 613670bfc..090e4e784 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgListConsumer.java
@@ -26,16 +26,17 @@
import org.apache.maven.scm.provider.hg.command.HgConsumer;
/**
- * Get a list of all files in the repository
+ * Get a list of all files in the repository.
*
* @author <a href="mailto:ryan@darksleep.com">ryan daum</a>
- *
*/
public class HgListConsumer extends HgConsumer {
private final List<ScmFile> files = new ArrayList<>();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String trimmedLine) {
files.add(new ScmFile(trimmedLine, status));
}
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgOutgoingConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgOutgoingConsumer.java
index 8ca646419..33fceabfc 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgOutgoingConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/inventory/HgOutgoingConsumer.java
@@ -24,10 +24,9 @@
import org.apache.maven.scm.provider.hg.command.HgConsumer;
/**
- * Get a list of outgoing changes
+ * Get a list of outgoing changes.
*
* @author <a href="mailto:lperez@xebia.fr">Laurent Perez</a>
- *
*/
public class HgOutgoingConsumer extends HgConsumer {
private List<HgChangeSet> changes = new CopyOnWriteArrayList<>();
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveCommand.java
index 24a0e86ac..a65b92de8 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveCommand.java
@@ -32,10 +32,11 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgRemoveCommand extends AbstractRemoveCommand implements Command {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeRemoveCommand(ScmProviderRepository repository, ScmFileSet fileSet, String message)
throws ScmException {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveConsumer.java
index 4bc3f2298..6108f9c8c 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/remove/HgRemoveConsumer.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgRemoveConsumer extends HgConsumer {
private final File workingDir;
@@ -40,7 +39,9 @@ public HgRemoveConsumer(File workingDir) {
this.workingDir = workingDir;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String trimmedLine) {
if (status == ScmFileStatus.DELETED) {
// Only include real files (not directories)
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusCommand.java
index 0641e295b..18385d0db 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusCommand.java
@@ -39,7 +39,9 @@ public HgStatusCommand() {
super();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public StatusScmResult executeStatusCommand(ScmProviderRepository repo, ScmFileSet fileSet) throws ScmException {
File workingDir = fileSet.getBasedir();
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusConsumer.java
index c7f1f030b..5ac12df79 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/status/HgStatusConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
class HgStatusConsumer extends HgConsumer {
private final List<ScmFile> repositoryStatus = new ArrayList<>();
@@ -39,7 +38,9 @@ class HgStatusConsumer extends HgConsumer {
this.workingDir = workingDir;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String trimmedLine) {
// Only include real files (not directories)
File tmpFile = new File(workingDir, trimmedLine);
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagCommand.java
index 3e0ffa660..3372abe37 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagCommand.java
@@ -39,11 +39,10 @@
import org.apache.maven.scm.provider.hg.repository.HgScmProviderRepository;
/**
- * Tag
+ * Tag.
*
* @author <a href="mailto:ryan@darksleep.com">ryan daum</a>
* @author Olivier Lamy
- *
*/
public class HgTagCommand extends AbstractTagCommand implements Command {
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagConsumer.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagConsumer.java
index 023b1cdb5..e41156015 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagConsumer.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/tag/HgTagConsumer.java
@@ -23,9 +23,10 @@
/**
* @author <a href="mailto:ryan@darksleep.com">ryan daum</a>
- *
*/
public class HgTagConsumer extends HgConsumer {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void doConsume(ScmFileStatus status, String trimmedLine) {}
}
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/update/HgUpdateCommand.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/update/HgUpdateCommand.java
index 8a80be9e4..fb495beff 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/update/HgUpdateCommand.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/command/update/HgUpdateCommand.java
@@ -45,10 +45,11 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
* @author Olivier Lamy
- *
*/
public class HgUpdateCommand extends AbstractUpdateCommand implements Command {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected UpdateScmResult executeUpdateCommand(ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion tag)
throws ScmException {
File workingDir = fileSet.getBasedir();
diff --git a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/repository/HgScmProviderRepository.java b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/repository/HgScmProviderRepository.java
index f3ad13c77..f7d4bc5e0 100644
--- a/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/repository/HgScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-provider-hg/src/main/java/org/apache/maven/scm/provider/hg/repository/HgScmProviderRepository.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:thurner.rupert@ymono.net">thurner rupert</a>
- *
*/
public class HgScmProviderRepository extends ScmProviderRepositoryWithHost {
// Known and tested protocols
@@ -59,7 +58,7 @@ public String getURI() {
}
/**
- * @return A message if the repository as an invalid URI, null if the URI seems fine.
+ * @return a message if the repository as an invalid URI, null if the URI seems fine
*/
public String validateURI() {
@@ -207,7 +206,9 @@ private String addAuthority() {
private boolean canAuthenticate() {
return needsAuthentication() || Objects.equals(protocol, HTTP);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return "Hg Repository Interpreted from: " + orgUrl + ":\nProtocol: " + protocol + "\nHost: " + getHost()
+ "\nPort: " + getPort() + "\nUsername: " + getUser() + "\nPassword: " + getPassword() + "\nPath: "
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/LocalScmProvider.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/LocalScmProvider.java
index 8c1abd6d9..f98e0eaa8 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/LocalScmProvider.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/LocalScmProvider.java
@@ -57,13 +57,17 @@
@Singleton
@Named("local")
public class LocalScmProvider extends AbstractScmProvider {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getScmType() {
return "local";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, char delimiter)
throws ScmRepositoryException {
@@ -132,7 +136,9 @@ public static String fixModuleName(String module) {
return module;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -141,7 +147,9 @@ public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileS
return (StatusScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -150,7 +158,9 @@ public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, Co
return (TagScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -159,7 +169,9 @@ public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, Co
return (AddScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected ChangeLogScmResult changelog(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
@@ -168,7 +180,9 @@ protected ChangeLogScmResult changelog(
return (ChangeLogScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -177,7 +191,9 @@ public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fil
return (CheckInScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public CheckOutScmResult checkout(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
@@ -186,7 +202,9 @@ public CheckOutScmResult checkout(
return (CheckOutScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected ListScmResult list(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -195,7 +213,9 @@ protected ListScmResult list(ScmProviderRepository repository, ScmFileSet fileSe
return (ListScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected MkdirScmResult mkdir(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
@@ -204,7 +224,9 @@ protected MkdirScmResult mkdir(ScmProviderRepository repository, ScmFileSet file
return (MkdirScmResult) command.execute(repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/LocalCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/LocalCommand.java
index e3b39ef13..a9cc3889b 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/LocalCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/LocalCommand.java
@@ -22,6 +22,5 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public interface LocalCommand extends Command {}
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/add/LocalAddCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/add/LocalAddCommand.java
index 3f4e0efad..4bc6a1465 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/add/LocalAddCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/add/LocalAddCommand.java
@@ -35,10 +35,11 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class LocalAddCommand extends AbstractAddCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeAddCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean binary) throws ScmException {
LocalScmProviderRepository localRepo = (LocalScmProviderRepository) repository;
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/changelog/LocalChangeLogCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/changelog/LocalChangeLogCommand.java
index eca02275e..391bb6556 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/changelog/LocalChangeLogCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/changelog/LocalChangeLogCommand.java
@@ -39,10 +39,11 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class LocalChangeLogCommand extends AbstractChangeLogCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ChangeLogScmResult executeChangeLogCommand(
ScmProviderRepository repository,
ScmFileSet fileSet,
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkin/LocalCheckInCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkin/LocalCheckInCommand.java
index 89582f390..92318d6a3 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkin/LocalCheckInCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkin/LocalCheckInCommand.java
@@ -39,10 +39,11 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class LocalCheckInCommand extends AbstractCheckInCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected CheckInScmResult executeCheckInCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String message, ScmVersion version) throws ScmException {
LocalScmProviderRepository repository = (LocalScmProviderRepository) repo;
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutCommand.java
index ab820d793..d35f0c2c4 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutCommand.java
@@ -38,10 +38,11 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class LocalCheckOutCommand extends AbstractCheckOutCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected CheckOutScmResult executeCheckOutCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version, boolean recursive, boolean shallow)
throws ScmException {
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutScmResult.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutScmResult.java
index 347828909..e09e8f23e 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutScmResult.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/checkout/LocalCheckOutScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class LocalCheckOutScmResult extends CheckOutScmResult {
private static final long serialVersionUID = -2646018573623668026L;
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListCommand.java
index 004346742..8d28c44f0 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListCommand.java
@@ -35,10 +35,11 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class LocalListCommand extends AbstractListCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ListScmResult executeListCommand(
ScmProviderRepository repo, ScmFileSet fileSet, boolean recursive, ScmVersion version) throws ScmException {
if (version != null) {
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListScmResult.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListScmResult.java
index 74fee24e0..da75b95f9 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListScmResult.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/list/LocalListScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class LocalListScmResult extends ListScmResult {
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/mkdir/LocalMkdirCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/mkdir/LocalMkdirCommand.java
index 457c995a0..5a1233b41 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/mkdir/LocalMkdirCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/mkdir/LocalMkdirCommand.java
@@ -38,7 +38,6 @@
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public class LocalMkdirCommand extends AbstractMkdirCommand {
protected MkdirScmResult executeMkdirCommand(
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/status/LocalStatusCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/status/LocalStatusCommand.java
index 8738f247f..d76138345 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/status/LocalStatusCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/status/LocalStatusCommand.java
@@ -29,10 +29,11 @@
/**
* @author <a href="mailto:matthewm@ambientideas.com">Matthew McCullough</a>
- *
*/
public class LocalStatusCommand extends AbstractStatusCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected StatusScmResult executeStatusCommand(ScmProviderRepository repository, ScmFileSet fileSet)
throws ScmException {
return new StatusScmResult(null, Collections.emptyList());
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/tag/LocalTagCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/tag/LocalTagCommand.java
index 7b498af25..2840cfeb6 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/tag/LocalTagCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/tag/LocalTagCommand.java
@@ -32,10 +32,11 @@
/**
* @author <a href="mailto:matthewm@ambientideas.com">Matthew McCullough</a>
* @author Olivier Lamy
- *
*/
public class LocalTagCommand extends AbstractTagCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeTagCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message, ScmTagParameters scmTagParameters)
throws ScmException {
@@ -43,7 +44,9 @@ protected ScmResult executeTagCommand(
}
// Satisfies deprecated interface
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeTagCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String tagName, String message) throws ScmException {
return new TagScmResult(null, Collections.emptyList());
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateCommand.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateCommand.java
index 64424df6f..ac2ce6f7b 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateCommand.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateCommand.java
@@ -43,10 +43,11 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class LocalUpdateCommand extends AbstractUpdateCommand implements LocalCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected UpdateScmResult executeUpdateCommand(ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version)
throws ScmException {
LocalScmProviderRepository repository = (LocalScmProviderRepository) repo;
@@ -169,7 +170,9 @@ private List<ScmFile> update(File source, File baseDestination, List<File> files
return updatedFiles;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ChangeLogCommand getChangeLogCommand() {
return new LocalChangeLogCommand();
}
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateScmResult.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateScmResult.java
index 2dbee4afd..5111f6b36 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateScmResult.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/command/update/LocalUpdateScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class LocalUpdateScmResult extends UpdateScmResult {
private static final long serialVersionUID = -932254303678432167L;
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 1ec78aaf9..42b167085 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
@@ -34,21 +34,20 @@
import org.slf4j.LoggerFactory;
/**
- * Utils for dealing with LocalScmMetadata
+ * Utils for dealing with LocalScmMetadata.
*
* @author <a href="mailto:arne@degenring.de">Arne Degenring</a>
- *
*/
public class LocalScmMetadataUtils {
/**
- * The name of the metadata file
+ * The name of the metadata file.
*/
public static final String FILENAME = ".maven-scm-local";
private static final Logger LOGGER = LoggerFactory.getLogger(LocalScmMetadataUtils.class);
/**
- * Builds LocalScmMetadata based on contents of repository
+ * Builds LocalScmMetadata based on contents of repository.
*
* @param repository
* @return TODO
@@ -63,7 +62,7 @@ public LocalScmMetadata buildMetadata(File repository) throws IOException {
}
/**
- * Writes metadata file
+ * Writes metadata file.
*
* @param destinationDir
* @param metadata
@@ -81,7 +80,7 @@ public void writeMetadata(File destinationDir, LocalScmMetadata metadata) throws
/**
* Reads metadata file from given directory.
*
- * @param dir The directory that should contain the metadata file
+ * @param dir the directory that should contain the metadata file
* @return LocalScmMetadata or <code>null</code> in case of problems
*/
public LocalScmMetadata readMetadata(File dir) {
diff --git a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/repository/LocalScmProviderRepository.java b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/repository/LocalScmProviderRepository.java
index cc4c8f7ba..e630bef25 100644
--- a/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/repository/LocalScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-provider-local/src/main/java/org/apache/maven/scm/provider/local/repository/LocalScmProviderRepository.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class LocalScmProviderRepository extends ScmProviderRepository {
private String root;
@@ -45,14 +44,14 @@ public LocalScmProviderRepository(String root, String module) {
}
/**
- * @return Returns the root.
+ * @return returns the root
*/
public String getRoot() {
return root;
}
/**
- * @return Returns the module.
+ * @return returns the module
*/
public String getModule() {
return module;
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/AbstractGitScmProvider.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/AbstractGitScmProvider.java
index c4cc398bc..52383c89f 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/AbstractGitScmProvider.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/AbstractGitScmProvider.java
@@ -50,11 +50,9 @@
import org.apache.maven.scm.repository.UnknownRepositoryStructure;
/**
- * SCM Provider for git
- *
+ * SCM Provider for git.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractGitScmProvider extends AbstractScmProvider {
@@ -63,7 +61,7 @@ public abstract class AbstractGitScmProvider extends AbstractScmProvider {
// ----------------------------------------------------------------------
/**
- * Internal class
+ * Internal class.
*/
private static class ScmUrlParserResult {
private final List<String> messages = new ArrayList<>();
@@ -75,12 +73,16 @@ private static class ScmUrlParserResult {
// ScmProvider Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmSpecificFilename() {
return ".git";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, char delimiter)
throws ScmRepositoryException {
try {
@@ -97,7 +99,9 @@ public ScmProviderRepository makeProviderScmRepository(String scmSpecificUrl, ch
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmProviderRepository makeProviderScmRepository(File path)
throws ScmRepositoryException, UnknownRepositoryStructure {
if (path == null) {
@@ -122,7 +126,9 @@ public ScmProviderRepository makeProviderScmRepository(File path)
protected abstract String getRepositoryURL(File path) throws ScmException;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public List<String> validateScmUrl(String scmSpecificUrl, char delimiter) {
List<String> messages = new ArrayList<>();
try {
@@ -133,7 +139,9 @@ public List<String> validateScmUrl(String scmSpecificUrl, char delimiter) {
return messages;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmType() {
return "git";
}
@@ -144,7 +152,7 @@ public String getScmType() {
/**
* The git-submodule(1) command is available since Git 1.5.3, so modules will
- * be activated in a later stage
+ * be activated in a later stage.
*/
private ScmUrlParserResult parseScmUrl(String scmSpecificUrl, char delimiter) throws ScmException {
ScmUrlParserResult result = new ScmUrlParserResult();
@@ -156,7 +164,9 @@ private ScmUrlParserResult parseScmUrl(String scmSpecificUrl, char delimiter) th
protected abstract GitCommand getAddCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (AddScmResult) executeCommand(getAddCommand(), repository, fileSet, parameters);
@@ -164,7 +174,9 @@ public AddScmResult add(ScmProviderRepository repository, ScmFileSet fileSet, Co
protected abstract GitCommand getBranchCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected BranchScmResult branch(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (BranchScmResult) executeCommand(getBranchCommand(), repository, fileSet, parameters);
@@ -172,7 +184,9 @@ protected BranchScmResult branch(ScmProviderRepository repository, ScmFileSet fi
protected abstract GitCommand getChangeLogCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ChangeLogScmResult changelog(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
return (ChangeLogScmResult) executeCommand(getChangeLogCommand(), repository, fileSet, parameters);
@@ -180,7 +194,9 @@ public ChangeLogScmResult changelog(
protected abstract GitCommand getCheckInCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (CheckInScmResult) executeCommand(getCheckInCommand(), repository, fileSet, parameters);
@@ -194,7 +210,9 @@ public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, Co
protected abstract GitCommand getCheckOutCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public CheckOutScmResult checkout(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
return (CheckOutScmResult) executeCommand(getCheckOutCommand(), repository, fileSet, parameters);
@@ -202,7 +220,9 @@ public CheckOutScmResult checkout(
protected abstract GitCommand getDiffCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (DiffScmResult) executeCommand(getDiffCommand(), repository, fileSet, parameters);
@@ -210,7 +230,9 @@ public DiffScmResult diff(ScmProviderRepository repository, ScmFileSet fileSet,
protected abstract GitCommand getExportCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ExportScmResult export(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (ExportScmResult) executeCommand(getExportCommand(), repository, fileSet, parameters);
@@ -218,7 +240,9 @@ protected ExportScmResult export(ScmProviderRepository repository, ScmFileSet fi
protected abstract GitCommand getRemoveCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (RemoveScmResult) executeCommand(getRemoveCommand(), repository, fileSet, parameters);
@@ -226,7 +250,9 @@ public RemoveScmResult remove(ScmProviderRepository repository, ScmFileSet fileS
protected abstract GitCommand getStatusCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (StatusScmResult) executeCommand(getStatusCommand(), repository, fileSet, parameters);
@@ -234,7 +260,9 @@ public StatusScmResult status(ScmProviderRepository repository, ScmFileSet fileS
protected abstract GitCommand getTagCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (TagScmResult) executeCommand(getTagCommand(), repository, fileSet, parameters);
@@ -242,7 +270,9 @@ public TagScmResult tag(ScmProviderRepository repository, ScmFileSet fileSet, Co
protected abstract GitCommand getUntagCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public UntagScmResult untag(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (UntagScmResult)
@@ -251,7 +281,9 @@ public UntagScmResult untag(ScmRepository repository, ScmFileSet fileSet, Comman
protected abstract GitCommand getUpdateCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public UpdateScmResult update(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
return (UpdateScmResult) executeCommand(getUpdateCommand(), repository, fileSet, parameters);
@@ -272,7 +304,9 @@ public InfoScmResult info(ScmProviderRepository repository, ScmFileSet fileSet,
return (InfoScmResult) executeCommand(cmd, repository, fileSet, parameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected BlameScmResult blame(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
throws ScmException {
GitCommand cmd = getBlameCommand();
@@ -282,7 +316,9 @@ protected BlameScmResult blame(ScmProviderRepository repository, ScmFileSet file
protected abstract GitCommand getBlameCommand();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public RemoteInfoScmResult remoteInfo(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
GitCommand cmd = getRemoteInfoCommand();
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitCommandUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitCommandUtils.java
index df08f0fea..dee87f093 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitCommandUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitCommandUtils.java
@@ -28,7 +28,6 @@
* Command utilities for git commands.
*
* @author <a href="mailto:jerome@coffeebreaks.org">Jerome Lacoste</a>
- *
*/
public class GitCommandUtils {
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitConfigFileReader.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitConfigFileReader.java
index 90687eada..4899e4ff3 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitConfigFileReader.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/GitConfigFileReader.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class GitConfigFileReader {
private File configDirectory;
@@ -95,7 +94,7 @@ public String getProperty(String group, String propertyName) {
}
/**
- * Load the git config file
+ * Load the git config file.
*
* @return the list of all lines
*/
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/GitCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/GitCommand.java
index 50dd61158..6038d127e 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/GitCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/GitCommand.java
@@ -22,6 +22,5 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public interface GitCommand extends Command {}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffConsumer.java
index 595fe395e..ed5e04f23 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffConsumer.java
@@ -34,7 +34,6 @@
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitDiffConsumer extends AbstractConsumer {
// diff --git a/readme.txt b/readme.txt
@@ -47,9 +46,9 @@ public class GitDiffConsumer extends AbstractConsumer {
// +new version of /readme.txt
/**
- * patern matches the index line of the diff comparison
+ * Patern matches the index line of the diff comparison
* paren.1 matches the first file
- * paren.2 matches the 2nd file
+ * paren.2 matches the 2nd file.
*/
private static final Pattern DIFF_FILES_PATTERN = Pattern.compile("^diff --git\\sa/(.*)\\sb/(.*)");
@@ -101,7 +100,9 @@ public GitDiffConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
Matcher matcher = DIFF_FILES_PATTERN.matcher(line);
if (matcher.matches()) {
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoItem.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoItem.java
index 69d4323ff..4d835087c 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoItem.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoItem.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
*/
public class GitInfoItem extends InfoItem {
// no op
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoScmResult.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoScmResult.java
index f159344ac..70f7f7a7c 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoScmResult.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
*/
public class GitInfoScmResult extends InfoScmResult {
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateScmResult.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateScmResult.java
index 933362f3b..0b969da87 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateScmResult.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
* @deprecated
*/
public class GitUpdateScmResult extends UpdateScmResultWithRevision {
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 9daf3b8ff..e657c2b3e 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
@@ -31,52 +31,51 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:struberg@apache.org">Mark Struberg</a>
- *
*/
public class GitScmProviderRepository extends ScmProviderRepositoryWithHost {
/**
- * sequence used to delimit the fetch URL
+ * Sequence used to delimit the fetch URL.
*/
public static final String URL_DELIMITER_FETCH = "[fetch=]";
/**
- * sequence used to delimit the push URL
+ * Sequence used to delimit the push URL.
*/
public static final String URL_DELIMITER_PUSH = "[push=]";
/**
- * this trails every protocol
+ * This trails every protocol.
*/
public static final String PROTOCOL_SEPARATOR = "://";
/**
- * use local file as transport
+ * Use local file as transport.
*/
public static final String PROTOCOL_FILE = "file";
/**
- * use gits internal protocol
+ * Use gits internal protocol.
*/
public static final String PROTOCOL_GIT = "git";
/**
- * use secure shell protocol
+ * Use secure shell protocol.
*/
public static final String PROTOCOL_SSH = "ssh";
/**
- * use the standard port 80 http protocol
+ * Use the standard port 80 http protocol.
*/
public static final String PROTOCOL_HTTP = "http";
/**
- * use the standard port 443 https protocol
+ * Use the standard port 443 https protocol.
*/
public static final String PROTOCOL_HTTPS = "https";
/**
- * use rsync for retrieving the data
+ * Use rsync for retrieving the data
* TODO implement!
*/
public static final String PROTOCOL_RSYNC = "rsync";
@@ -86,22 +85,22 @@ public class GitScmProviderRepository extends ScmProviderRepositoryWithHost {
/**
* No special protocol specified. Git will either use git://
- * or ssh:// depending on whether we work locally or over the network
+ * or ssh:// depending on whether we work locally or over the network.
*/
public static final String PROTOCOL_NONE = "";
/**
- * this may either 'git' or 'jgit' depending on the underlying implementation being used
+ * This may either 'git' or 'jgit' depending on the underlying implementation being used.
*/
private String provider;
/**
- * the URL used to fetch from the upstream repository
+ * The URL used to fetch from the upstream repository.
*/
private RepositoryUrl fetchInfo;
/**
- * the URL used to push to the upstream repository
+ * The URL used to push to the upstream repository.
*/
private RepositoryUrl pushInfo;
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/RepositoryUrl.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/RepositoryUrl.java
index b56d94139..f13e593e7 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/RepositoryUrl.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/repository/RepositoryUrl.java
@@ -21,28 +21,28 @@
/**
* This class is a container which holds information about
* repository URL.
- * @author <a href="mailto:struberg@apache.org">Mark Struberg</a>
*
+ * @author <a href="mailto:struberg@apache.org">Mark Struberg</a>
* @since 1.3
*/
public class RepositoryUrl {
- /** the protocol used to access the upstream repository */
+ /** The protocol used to access the upstream repository. */
private String protocol;
- /** the server to access the upstream repository */
+ /** The server to access the upstream repository. */
private String host;
- /** the port to access the upstream repository */
+ /** The port to access the upstream repository. */
private String port;
- /** the path on the server to access the upstream repository */
+ /** The path on the server to access the upstream repository. */
private String path;
- /** the user name from the repository URL */
+ /** The user name from the repository URL. */
private String userName;
- /** the password from the repository URL */
+ /** The password from the repository URL. */
private String password;
public String getProtocol() {
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/util/GitUtil.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/util/GitUtil.java
index 340e512b3..4b3eef69d 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/util/GitUtil.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/util/GitUtil.java
@@ -37,9 +37,11 @@ public class GitUtil {
public static final File DEFAULT_SETTINGS_DIRECTORY = new File(System.getProperty("user.home"), ".scm");
- /** The password placeholder must contain delimiters.
- * Otherwise replacing may replace other portions of the URL as well
- * and in worst case passwords could be guessed. */
+ /**
+ * The password placeholder must contain delimiters.
+ * Otherwise replacing may replace other portions of the URL as well
+ * and in worst case passwords could be guessed.
+ */
public static final String PASSWORD_PLACE_HOLDER_WITH_DELIMITERS = ":********@";
private static final Pattern PASSWORD_IN_URL_PATTERN = Pattern.compile("^.*(:[^/].*@).*$");
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/GitExeScmProvider.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/GitExeScmProvider.java
index 0c2bd20bf..9d85bb9fb 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/GitExeScmProvider.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/GitExeScmProvider.java
@@ -57,6 +57,7 @@ public class GitExeScmProvider extends AbstractGitScmProvider {
/**
* The environment variable that controls whether Git prompts for credentials in the terminal.
+ *
* @see <a href="https://git-scm.com/docs/git-credential#Documentation/git-credential.txt-envGIT_TERMINAL_PROMPT">GIT_TERMINAL_PROMPT</a>
*/
private static final String GIT_TERMINAL_PROMPT = "GIT_TERMINAL_PROMPT";
@@ -75,82 +76,114 @@ public void setInteractive(boolean interactive) {
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getAddCommand() {
return new GitAddCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getBranchCommand() {
return new GitBranchCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getChangeLogCommand() {
return new GitChangeLogCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getCheckInCommand() {
return new GitCheckInCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getCheckOutCommand() {
return new GitCheckOutCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getDiffCommand() {
return new GitDiffCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getExportCommand() {
return null; // X TODO
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getRemoveCommand() {
return new GitRemoveCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getStatusCommand() {
return new GitStatusCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getTagCommand() {
return new GitTagCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getUntagCommand() {
return new GitUntagCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getUpdateCommand() {
return new GitUpdateCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public GitCommand getInfoCommand() {
return new GitInfoCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getBlameCommand() {
return new GitBlameCommand();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected GitCommand getRemoteInfoCommand() {
return new GitRemoteInfoCommand(environmentVariables);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected String getRepositoryURL(File path) throws ScmException {
// Note: I need to supply just 1 absolute path, but ScmFileSet won't let me without
// a basedir (which isn't used here anyway), so use a dummy file.
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/AbstractFileCheckingConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AbstractFileCheckingConsumer.java
index e31609342..c431da5d5 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AbstractFileCheckingConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AbstractFileCheckingConsumer.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
* @author Olivier Lamy
- *
*/
public abstract class AbstractFileCheckingConsumer extends AbstractConsumer {
protected File workingDirectory;
@@ -44,7 +43,9 @@ public AbstractFileCheckingConsumer(File workingDirectory) {
this.workingDirectory = workingDirectory;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public final void consumeLine(String line) {
if (line.length() <= 3) {
return;
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/AnonymousCommandLine.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AnonymousCommandLine.java
index 9128a915e..a991fb797 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AnonymousCommandLine.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/AnonymousCommandLine.java
@@ -22,7 +22,8 @@
import org.codehaus.plexus.util.cli.Commandline;
/**
- * CommandLine extension to mask password
+ * CommandLine extension to mask password.
+ *
* @since 1.9.3
*/
public class AnonymousCommandLine extends Commandline {
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 d693a89b6..647b0c2bb 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
@@ -42,7 +42,6 @@
*
* @author Brett Porter
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public final class GitCommandLineUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(GitCommandLineUtils.class);
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/blame/GitBlameConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/blame/GitBlameConsumer.java
index c7a083cb3..55147ee92 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/blame/GitBlameConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/blame/GitBlameConsumer.java
@@ -55,7 +55,7 @@ public class GitBlameConsumer extends AbstractConsumer {
* this information somwehere.
*
* key: the sha-1 of the commit
- * value: the {@link BlameLine} containing the full committer/author info
+ * value: the {@link BlameLine} containing the full committer/author info.
*/
private final Map<String, BlameLine> commitInfo = new HashMap<>();
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/branch/GitBranchCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitBranchCommand.java
index fb3c130db..df8fbbe24 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitBranchCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitBranchCommand.java
@@ -38,7 +38,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitBranchCommand extends AbstractBranchCommand implements GitCommand {
private final Map<String, String> environmentVariables;
@@ -47,7 +46,9 @@ public GitBranchCommand(Map<String, String> environmentVariables) {
this.environmentVariables = environmentVariables;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeBranchCommand(ScmProviderRepository repo, ScmFileSet fileSet, String branch, String message)
throws ScmException {
if (branch == null || branch.trim().isEmpty()) {
@@ -120,7 +121,7 @@ public Commandline createPushCommandLine(GitScmProviderRepository repository, Sc
}
/**
- * Helper function to detect the current branch
+ * Helper function to detect the current branch.
*/
public static String getCurrentBranch(GitScmProviderRepository repository, ScmFileSet fileSet) throws ScmException {
Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(fileSet.getBasedir(), "symbolic-ref");
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/branch/GitCurrentBranchConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitCurrentBranchConsumer.java
index d56a16bea..a3ab1848c 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitCurrentBranchConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitCurrentBranchConsumer.java
@@ -23,8 +23,8 @@
/**
* This logger parses the output of <i>git symbolic-ref HEAD</i>
* to determine the current branch.
- * @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
*
+ * @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
*/
public class GitCurrentBranchConsumer extends AbstractConsumer {
@@ -40,7 +40,9 @@ public String getBranchName() {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
line = line.trim();
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/changelog/GitChangeLogCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogCommand.java
index fccb27712..4b263b1e3 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogCommand.java
@@ -45,7 +45,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class GitChangeLogCommand extends AbstractChangeLogCommand implements GitCommand {
private static final String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss Z";
@@ -66,7 +65,9 @@ public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fil
parameters.getScmVersion(CommandParameter.SCM_VERSION, null));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected ChangeLogScmResult executeChangeLogCommand(
ScmProviderRepository repo,
@@ -78,7 +79,9 @@ protected ChangeLogScmResult executeChangeLogCommand(
return executeChangeLogCommand(repo, fileSet, null, null, null, datePattern, startVersion, endVersion);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
protected ChangeLogScmResult executeChangeLogCommand(
ScmProviderRepository repo,
@@ -204,14 +207,14 @@ protected ChangeLogScmResult executeChangeLogCommand(
* Since it uses --since and --until for the start and end date, the branch
* and version parameters can be used simultanously.
*
- * @param repository Provider repositry to use.
- * @param workingDirectory Working copy directory.
- * @param branch Branch to run command on.
- * @param startDate Start date of log entries.
- * @param endDate End date of log entries.
- * @param startVersion Start version of log entries.
- * @param endVersion End version of log entries.
- * @return Command line.
+ * @param repository provider repositry to use
+ * @param workingDirectory working copy directory
+ * @param branch branch to run command on
+ * @param startDate start date of log entries
+ * @param endDate end date of log entries
+ * @param startVersion start version of log entries
+ * @param endVersion end version of log entries
+ * @return command line
*/
public static Commandline createCommandLine(
GitScmProviderRepository repository,
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/changelog/GitChangeLogConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogConsumer.java
index cf9acde9e..3c974aefe 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/changelog/GitChangeLogConsumer.java
@@ -35,67 +35,66 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitChangeLogConsumer extends AbstractConsumer {
/**
* Date formatter for git timestamp
- * we use iso format cli git log --date=iso sample : 2008-08-06 01:37:18 +0200
+ * we use iso format cli git log --date=iso sample : 2008-08-06 01:37:18 +0200.
*/
private static final String GIT_TIMESTAMP_PATTERN = "yyyy-MM-dd HH:mm:ss Z";
/**
- * State machine constant: expecting header
+ * State machine constant: expecting header.
*/
private static final int STATUS_GET_HEADER = 1;
/**
- * State machine constant: expecting author information
+ * State machine constant: expecting author information.
*/
private static final int STATUS_GET_AUTHOR = 2;
/**
- * State machine constant: expecting parent hash information
+ * State machine constant: expecting parent hash information.
*/
private static final int STATUS_RAW_TREE = 21;
/**
- * State machine constant: expecting parent hash information
+ * State machine constant: expecting parent hash information.
*/
private static final int STATUS_RAW_PARENT = 22;
/**
- * State machine constant: expecting author name, email and timestamp information
+ * State machine constant: expecting author name, email and timestamp information.
*/
private static final int STATUS_RAW_AUTHOR = 23;
/**
- * State machine constant: expecting committer name, email and timestamp information
+ * State machine constant: expecting committer name, email and timestamp information.
*/
private static final int STATUS_RAW_COMMITTER = 24;
/**
- * State machine constant: expecting date information
+ * State machine constant: expecting date information.
*/
private static final int STATUS_GET_DATE = 3;
/**
- * State machine constant: expecting file information
+ * State machine constant: expecting file information.
*/
private static final int STATUS_GET_FILE = 4;
/**
- * State machine constant: expecting comments
+ * State machine constant: expecting comments.
*/
private static final int STATUS_GET_COMMENT = 5;
/**
- * The pattern used to match git header lines
+ * The pattern used to match git header lines.
*/
private static final Pattern HEADER_PATTERN = Pattern.compile("^commit ([A-Fa-f0-9]+)(?: \\((.*)\\))?$");
/**
- * The pattern used to match git author lines
+ * The pattern used to match git author lines.
*/
private static final Pattern AUTHOR_PATTERN = Pattern.compile("^Author: (.*)");
@@ -120,38 +119,38 @@ public class GitChangeLogConsumer extends AbstractConsumer {
private static final Pattern RAW_COMMITTER_PATTERN = Pattern.compile("^committer (.+ <.+>) ([0-9]+) (.*)");
/**
- * The pattern used to match git date lines
+ * The pattern used to match git date lines.
*/
private static final Pattern DATE_PATTERN = Pattern.compile("^Date:\\s*(.*)");
/**
- * The pattern used to match git file lines
+ * The pattern used to match git file lines.
*/
private static final Pattern FILE_PATTERN =
Pattern.compile("^:\\d* \\d* [A-Fa-f0-9]*\\.* [A-Fa-f0-9]*\\.* ([A-Z])[0-9]*\\t([^\\t]*)(\\t(.*))?");
/**
- * Current status of the parser
+ * Current status of the parser.
*/
private int status = STATUS_GET_HEADER;
/**
- * List of change log entries
+ * List of change log entries.
*/
private final List<ChangeSet> entries = new ArrayList<>();
/**
- * The current log entry being processed by the parser
+ * The current log entry being processed by the parser.
*/
private ChangeSet currentChange;
/**
- * The current revision of the entry being processed by the parser
+ * The current revision of the entry being processed by the parser.
*/
private String currentRevision;
/**
- * The current comment of the entry being processed by the parser
+ * The current comment of the entry being processed by the parser.
*/
private StringBuilder currentComment;
@@ -223,7 +222,7 @@ public void consumeLine(String line) {
* branch is given a single revision number, which is also used for
* the revision number of each file.
*
- * @param line A line of text from the git log output
+ * @param line a line of text from the git log output
*/
private void processGetHeader(String line) {
Matcher matcher = HEADER_PATTERN.matcher(line);
@@ -413,7 +412,7 @@ private void processGetComment(String line) {
* the revision number for the entire entry is used for the revision
* number of each file.
*
- * @param line A line of text from the git log output
+ * @param line a line of text from the git log output
*/
private void processGetFile(String line) {
if (line.length() == 0) {
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/checkin/GitCheckInCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkin/GitCheckInCommand.java
index 6a1674fea..02be947e5 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkin/GitCheckInCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/checkin/GitCheckInCommand.java
@@ -52,7 +52,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitCheckInCommand extends AbstractCheckInCommand implements GitCommand {
private final Map<String, String> environmentVariables;
@@ -69,7 +68,9 @@ protected CheckInScmResult executeCheckInCommand(
return executeCheckInCommand(repository, fileSet, message, scmVersion, SignOption.DEFAULT);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected CheckInScmResult executeCheckInCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String message, ScmVersion version, SignOption signOption)
throws ScmException {
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 35ad6d7b4..822f0667e 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
@@ -46,7 +46,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitCheckOutCommand extends AbstractCheckOutCommand implements GitCommand {
private final Map<String, String> environmentVariables;
@@ -164,7 +163,7 @@ public static Commandline createCommandLine(
}
/**
- * create a git-clone repository command
+ * Create a git-clone repository command.
*/
private Commandline createCloneCommand(
GitScmProviderRepository repository,
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/diff/GitDiffCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffCommand.java
index 98ede5731..9401688ac 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffCommand.java
@@ -35,10 +35,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitDiffCommand extends AbstractDiffCommand implements GitCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected DiffScmResult executeDiffCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion startVersion, ScmVersion endVersion)
throws ScmException {
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/diff/GitDiffRawConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffRawConsumer.java
index 3664a3164..337887d03 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffRawConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/diff/GitDiffRawConsumer.java
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitDiffRawConsumer extends AbstractConsumer {
private final List<ScmFile> changedFiles = new ArrayList<>();
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 7e398d526..08262db6b 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
@@ -39,6 +39,7 @@
/**
* Uses {@code git log} command to retrieve info about the most recent commits related to specific files.
+ *
* @author Olivier Lamy
* @since 1.5
*/
@@ -86,7 +87,7 @@ protected InfoItem executeInfoCommand(Commandline cli, CommandParameters paramet
}
/**
- * Get the revision length from the parameters
+ * Get the revision length from the parameters.
*
* @param parameters
* @return -1 if parameter {@link CommandParameter.SCM_SHORT_REVISION_LENGTH} is absent, <br>
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/GitInfoConsumer.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/GitInfoConsumer.java
index 3c1177983..70f9132e5 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/GitInfoConsumer.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/GitInfoConsumer.java
@@ -31,8 +31,8 @@
* Parses output of {@code git log} with a particular format and populates a {@link InfoItem}.
*
* @author Olivier Lamy
- * @since 1.5
* @see <a href="https://git-scm.com/docs/git-log#_pretty_formats">Pretty Formats</a>
+ * @since 1.5
*/
public class GitInfoConsumer extends AbstractConsumer {
@@ -64,7 +64,7 @@ public int getIndex() {
}
/**
- * @param line the line which is supposed to have the format as specified by {@link #getFormatArgument()}.
+ * @param line the line which is supposed to have the format as specified by {@link #getFormatArgument()}
* @see org.codehaus.plexus.util.cli.StreamConsumer#consumeLine(java.lang.String)
*/
public void consumeLine(String line) {
@@ -96,6 +96,7 @@ public InfoItem getInfoItem() {
/**
* The format argument to use with {@code git log}
+ *
* @return the format argument to use {@code git log} command
* @see <a href="https://git-scm.com/docs/git-log#_pretty_formats">Pretty Formats</a>
*/
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/list/GitListCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListCommand.java
index a7be9ea2d..b6d75a6b0 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListCommand.java
@@ -26,7 +26,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitListCommand {
public static Commandline createCommandLine(GitScmProviderRepository repository, File workingDirectory) {
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/list/GitListConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListConsumer.java
index ed8e3f27b..8c5e7b39d 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/list/GitListConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitListConsumer extends AbstractFileCheckingConsumer {
private final ScmFileStatus fileStatus;
@@ -43,7 +42,9 @@ public GitListConsumer(File workingDirectory, ScmFileStatus fileStatus) {
this.fileStatus = fileStatus;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void parseLine(String line) {
addFile(new ScmFile(line, fileStatus));
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/remoteinfo/GitRemoteInfoConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remoteinfo/GitRemoteInfoConsumer.java
index 3018a3784..f0bb10ab4 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remoteinfo/GitRemoteInfoConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remoteinfo/GitRemoteInfoConsumer.java
@@ -31,12 +31,12 @@
public class GitRemoteInfoConsumer extends AbstractConsumer {
/**
- * The pattern used to match branches
+ * The pattern used to match branches.
*/
private static final Pattern BRANCH_PATTERN = Pattern.compile("^(.*)\\s+refs/heads/(.*)");
/**
- * The pattern used to match tags
+ * The pattern used to match tags.
*/
private static final Pattern TAGS_PATTERN = Pattern.compile("^(.*)\\s+refs/tags/(.*)");
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/remove/GitRemoveCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveCommand.java
index 8a3227367..f50ed295f 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveCommand.java
@@ -37,7 +37,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitRemoveCommand extends AbstractRemoveCommand implements GitCommand {
/**
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/remove/GitRemoveConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveConsumer.java
index 401ce0f1e..db0f3cfe4 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/remove/GitRemoveConsumer.java
@@ -32,11 +32,10 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
* @author Olivier Lamy
- *
*/
public class GitRemoveConsumer extends AbstractConsumer {
/**
- * The pattern used to match deleted file lines
+ * The pattern used to match deleted file lines.
*/
private static final Pattern REMOVED_PATTERN = Pattern.compile("^rm\\s'(.*)'");
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/GitStatusCommand.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/GitStatusCommand.java
index ac6086a20..896895d58 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/GitStatusCommand.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/GitStatusCommand.java
@@ -34,10 +34,11 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class GitStatusCommand extends AbstractStatusCommand implements GitCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected StatusScmResult executeStatusCommand(ScmProviderRepository repo, ScmFileSet fileSet) throws ScmException {
int exitCode;
CommandLineUtils.StringStreamConsumer stderr;
@@ -68,10 +69,10 @@ protected StatusScmResult executeStatusCommand(ScmProviderRepository repo, ScmFi
/**
* Get the dir relative to the repository root.
*
- * @param logger the caller command logger.
- * @param fileSet in which subdir to execute.
- * @return the relative URI.
- * @throws ScmException if execute() fails.
+ * @param logger the caller command logger
+ * @param fileSet in which subdir to execute
+ * @return the relative URI
+ * @throws ScmException if execute() fails
*/
public static URI getRelativeCWD(Logger logger, ScmFileSet fileSet) throws ScmException {
Commandline clRevparse = createRevparseShowPrefix(fileSet);
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 859eda797..6f9dfbb4b 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
@@ -38,22 +38,22 @@
public class GitStatusConsumer extends AbstractConsumer {
/**
- * The pattern used to match added file lines
+ * The pattern used to match added file lines.
*/
private static final Pattern ADDED_PATTERN = Pattern.compile("^A[ M]* (.*)$");
/**
- * The pattern used to match modified file lines
+ * The pattern used to match modified file lines.
*/
private static final Pattern MODIFIED_PATTERN = Pattern.compile("^ *M[ M]* (.*)$");
/**
- * The pattern used to match deleted file lines
+ * The pattern used to match deleted file lines.
*/
private static final Pattern DELETED_PATTERN = Pattern.compile("^ *D * (.*)$");
/**
- * The pattern used to match renamed file lines
+ * The pattern used to match renamed file lines.
*/
private static final Pattern RENAMED_PATTERN = Pattern.compile("^R (.*) -> (.*)$");
@@ -62,7 +62,7 @@ public class GitStatusConsumer extends AbstractConsumer {
private ScmFileSet scmFileSet;
/**
- * Entries are relative to working directory, not to the repositoryroot
+ * Entries are relative to working directory, not to the repositoryroot.
*/
private final List<ScmFile> changedFiles = new ArrayList<>();
@@ -73,7 +73,7 @@ public class GitStatusConsumer extends AbstractConsumer {
// ----------------------------------------------------------------------
/**
- * Consumer when workingDirectory and repositoryRootDirectory are the same
+ * Consumer when workingDirectory and repositoryRootDirectory are the same.
*
* @param workingDirectory the working directory
*/
@@ -90,8 +90,8 @@ public GitStatusConsumer(File workingDirectory) {
*
* @param workingDirectory the working directory
* @param relativeRepositoryPath the working directory relative to the repository root
- * @since 1.9
* @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
+ * @since 1.9
*/
public GitStatusConsumer(File workingDirectory, URI relativeRepositoryPath) {
this(workingDirectory);
@@ -107,8 +107,8 @@ public GitStatusConsumer(File workingDirectory, URI relativeRepositoryPath) {
*
* @param workingDirectory the working directory
* @param scmFileSet fileset with includes and excludes
- * @since 1.11.0
* @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
+ * @since 1.11.0
*/
public GitStatusConsumer(File workingDirectory, ScmFileSet scmFileSet) {
this(workingDirectory);
@@ -125,8 +125,8 @@ public GitStatusConsumer(File workingDirectory, ScmFileSet scmFileSet) {
* @param workingDirectory the working directory
* @param relativeRepositoryPath the working directory relative to the repository root
* @param scmFileSet fileset with includes and excludes
- * @since 1.11.0
* @see GitStatusCommand#createRevparseShowPrefix(ScmFileSet)
+ * @since 1.11.0
*/
public GitStatusConsumer(File workingDirectory, URI relativeRepositoryPath, ScmFileSet scmFileSet) {
this(workingDirectory, scmFileSet);
@@ -242,7 +242,6 @@ public static String resolvePath(String fileEntry, URI path) {
}
/**
- *
* @param fileEntry the fileEntry, must not be {@code null}
* @param path the path, must not be {@code null}
* @return TODO
@@ -258,7 +257,7 @@ public static URI resolveURI(String fileEntry, URI path) {
* Create an URI whose getPath() returns the given path and getScheme() returns null. The path may contain spaces,
* colons, and other special characters.
*
- * @param path the path.
+ * @param path the path
* @return the new URI
*/
public static URI uriFromPath(String path) {
@@ -294,6 +293,7 @@ private static String stripQuotes(String str) {
/**
* Dequote a quoted string generated by git status --porcelain.
* The leading and trailing quotes have already been removed.
+ *
* @param fileEntry
* @return TODO
*/
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/tag/GitTagCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/tag/GitTagCommand.java
index b39047aaf..bec5fb17a 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/tag/GitTagCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/tag/GitTagCommand.java
@@ -43,7 +43,6 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitTagCommand extends AbstractTagCommand implements GitCommand {
private final Map<String, String> environmentVariables;
@@ -57,7 +56,9 @@ public ScmResult executeTagCommand(ScmProviderRepository repo, ScmFileSet fileSe
return executeTagCommand(repo, fileSet, tag, new ScmTagParameters(message));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeTagCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String tag, ScmTagParameters scmTagParameters)
throws ScmException {
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/untag/GitUntagCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/untag/GitUntagCommand.java
index 8abf00f4e..3dbf9d5da 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/untag/GitUntagCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/untag/GitUntagCommand.java
@@ -34,7 +34,9 @@
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
-/** {@inheritDoc} */
+/**
+ * {@inheritDoc}
+ */
public class GitUntagCommand extends AbstractUntagCommand implements GitCommand {
private final Map<String, String> environmentVariables;
@@ -42,7 +44,9 @@ public GitUntagCommand(Map<String, String> environmentVariables) {
this.environmentVariables = environmentVariables;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeUntagCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmUntagParameters scmUntagParameters) throws ScmException {
String tag = scmUntagParameters.getTag();
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/update/GitLatestRevisionCommandConsumer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitLatestRevisionCommandConsumer.java
index e9f4c6c29..b18436574 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitLatestRevisionCommandConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitLatestRevisionCommandConsumer.java
@@ -25,18 +25,19 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitLatestRevisionCommandConsumer extends AbstractConsumer {
/**
- * The pattern used to match git log latest revision lines
+ * The pattern used to match git log latest revision lines.
*/
private static final Pattern LATESTREV_PATTERN = Pattern.compile("^commit \\s*(.*)");
private String latestRevision;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (logger.isDebugEnabled()) {
logger.debug("GitLatestRevisionCommandConsumer consumeLine : " + line);
@@ -53,9 +54,9 @@ public String getLatestRevision() {
}
/**
- * Process the current input line for the latest revision
+ * Process the current input line for the latest revision.
*
- * @param line A line of text from the git log output
+ * @param line a line of text from the git log output
*/
private void processGetLatestRevision(String line) {
Matcher matcher = LATESTREV_PATTERN.matcher(line);
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/update/GitUpdateCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitUpdateCommand.java
index 9f9c9d954..bc3e8f357 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitUpdateCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/update/GitUpdateCommand.java
@@ -42,10 +42,11 @@
* @author Olivier Lamy
* @author <a href="mailto:struberg@yahoo.de">struberg</a>
* @since 10 august 2008
- *
*/
public class GitUpdateCommand extends AbstractUpdateCommand implements GitCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected UpdateScmResult executeUpdateCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion scmVersion) throws ScmException {
GitScmProviderRepository repository = (GitScmProviderRepository) repo;
@@ -100,13 +101,15 @@ protected UpdateScmResult executeUpdateCommand(
return new UpdateScmResultWithRevision(cl.toString(), diffRawConsumer.getChangedFiles(), latestRevision);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ChangeLogCommand getChangeLogCommand() {
return new GitChangeLogCommand();
}
/**
- * create the command line for updating the current branch with the info from the foreign repository.
+ * Create the command line for updating the current branch with the info from the foreign repository.
*/
public static Commandline createCommandLine(
GitScmProviderRepository repository, File workingDirectory, ScmVersion scmVersion) {
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitScmTestUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitScmTestUtils.java
index f00cce534..43d0e1ac1 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitScmTestUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitScmTestUtils.java
@@ -30,10 +30,9 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public final class GitScmTestUtils {
- /** 'git' command line */
+ /** 'git' command line. */
public static final String GIT_COMMAND_LINE = "git";
private GitScmTestUtils() {}
@@ -117,7 +116,6 @@ public static void setDefaultGitConfig(File repositoryRootFile, Consumer<FileWri
* that doesn't allow any new commits.
* This hook is <a href="https://github.com/eclipse-jgit/jgit/issues/192">not supported by JGit</a>.
*
- *
* @param repositoryRootFile the root directory of the git repository
* @throws IOException if there's an error creating or writing the hook file
*/
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitSshServer.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitSshServer.java
index bbf64f5db..514ce09ef 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitSshServer.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/GitSshServer.java
@@ -79,8 +79,8 @@ public GitSshServer() throws GeneralSecurityException {
*
* @param file the file to write the private key to
* @param passphrase the passphrase for encryption, or null for unencrypted
- * @throws IOException if an I/O error occurs
* @throws GeneralSecurityException if a security error occurs
+ * @throws IOException if an I/O error occurs
*/
public void writePrivateKeyAsPkcs8(Path file, String passphrase) throws IOException, GeneralSecurityException {
// encryption only optional
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitBranchCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitBranchCommandTckTest.java
index 68941bdc1..9d37f8c45 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitBranchCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitBranchCommandTckTest.java
@@ -32,10 +32,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitBranchCommandTckTest extends BranchCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitSshBranchCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitSshBranchCommandTckTest.java
index 60c90170d..cfc0bffe4 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitSshBranchCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/branch/GitSshBranchCommandTckTest.java
@@ -33,9 +33,6 @@
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
-/**
- *
- */
public abstract class GitSshBranchCommandTckTest extends BranchCommandTckTest {
protected final GitSshServer gitSshServer;
@@ -48,7 +45,9 @@ protected GitSshBranchCommandTckTest() throws GeneralSecurityException {
protected abstract String getScmProvider();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return "scm:" + getScmProvider() + ":ssh://localhost:" + gitSshServer.getPort() + "/repository";
}
@@ -63,7 +62,9 @@ public void configureCredentials(ScmRepository repository, String passphrase) th
providerRepository.setPassphrase(passphrase); // may be null
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
gitSshServer.start(getRepositoryRoot().getParentFile().toPath());
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/changelog/GitChangeLogCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/changelog/GitChangeLogCommandTckTest.java
index 3575b2344..e005c4b00 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/changelog/GitChangeLogCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/changelog/GitChangeLogCommandTckTest.java
@@ -46,7 +46,9 @@
public abstract class GitChangeLogCommandTckTest extends ChangeLogCommandTckTest {
public static final long SLEEP_TIME_IN_MILLIS = 250L;
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/linear-changelog/", getRepositoryRoot(), getWorkingCopy());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkin/GitCheckInCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkin/GitCheckInCommandTckTest.java
index e7dd50eb5..d13411010 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkin/GitCheckInCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkin/GitCheckInCommandTckTest.java
@@ -43,11 +43,12 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitCheckInCommandTckTest extends CheckInCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
@@ -163,6 +164,7 @@ private ScmFileSet createWorkspaceChange(File repo) throws IOException {
/**
* Creates a new file below a new temporary directory and copies the content of a classpath resource into it.
* The caller is responsible for deleting the temporary directory afterwards.
+ *
* @param resourceName from where to populate the file (relative to {@code clazz})
* @param fileName the file name to create below
* @return the newly created file
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitCheckOutCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitCheckOutCommandTckTest.java
index cd1e20388..674f26a97 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitCheckOutCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitCheckOutCommandTckTest.java
@@ -23,15 +23,18 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public class GitCheckOutCommandTckTest extends CheckOutCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return GitScmTestUtils.getScmUrl(getRepositoryRoot(), "git");
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitSshCheckOutCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitSshCheckOutCommandTckTest.java
index 9b262de91..335a42e9f 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitSshCheckOutCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/checkout/GitSshCheckOutCommandTckTest.java
@@ -31,9 +31,6 @@
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
-/**
- *
- */
public abstract class GitSshCheckOutCommandTckTest extends CheckOutCommandTckTest {
protected final GitSshServer gitSshServer;
@@ -46,7 +43,9 @@ protected GitSshCheckOutCommandTckTest() throws GeneralSecurityException {
protected abstract String getScmProvider();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return "scm:" + getScmProvider() + ":ssh://localhost:" + gitSshServer.getPort() + "/repository";
}
@@ -61,7 +60,9 @@ protected void configureCredentials(ScmRepository repository, String passphrase)
providerRepository.setPassphrase(passphrase); // may be null
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
gitSshServer.start(getRepositoryRoot().getParentFile().toPath());
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffCommandTckTest.java
index df0623e45..4a5e9a448 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/diff/GitDiffCommandTckTest.java
@@ -23,10 +23,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitDiffCommandTckTest extends DiffCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoCommandTckTest.java
index 65d6048b8..fa0a91570 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/info/GitInfoCommandTckTest.java
@@ -23,10 +23,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitInfoCommandTckTest extends InfoCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/list/GitListCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/list/GitListCommandTckTest.java
index d472e91f2..3a88d26ff 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/list/GitListCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/list/GitListCommandTckTest.java
@@ -23,10 +23,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitListCommandTckTest extends ListCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/remove/GitRemoveCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/remove/GitRemoveCommandTckTest.java
index 27670b6e9..bc32c628d 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/remove/GitRemoveCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/remove/GitRemoveCommandTckTest.java
@@ -27,12 +27,16 @@
* @author Georg Tsakumagos
*/
public abstract class GitRemoveCommandTckTest extends RemoveCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return GitScmTestUtils.getScmUrl(getRepositoryRoot(), "git");
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/status/GitStatusCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/status/GitStatusCommandTckTest.java
index 539c2ed88..f8dd77ab1 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/status/GitStatusCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/status/GitStatusCommandTckTest.java
@@ -27,10 +27,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitStatusCommandTckTest extends StatusCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitSshTagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitSshTagCommandTckTest.java
index eb7e60061..81d0c07f3 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitSshTagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitSshTagCommandTckTest.java
@@ -33,9 +33,6 @@
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
-/**
- *
- */
public abstract class GitSshTagCommandTckTest extends TagCommandTckTest {
protected final GitSshServer gitSshServer;
@@ -48,7 +45,9 @@ protected GitSshTagCommandTckTest() throws GeneralSecurityException {
protected abstract String getScmProvider();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return "scm:" + getScmProvider() + ":ssh://localhost:" + gitSshServer.getPort() + "/repository";
}
@@ -64,7 +63,9 @@ protected void configureCredentials(ScmRepository repository, String passphrase)
providerRepository.setPassphrase(passphrase); // may be null
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
gitSshServer.start(getRepositoryRoot().getParentFile().toPath());
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitTagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitTagCommandTckTest.java
index b151574de..0a9667cfc 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitTagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/tag/GitTagCommandTckTest.java
@@ -32,10 +32,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitTagCommandTckTest extends TagCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitSshUntagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitSshUntagCommandTckTest.java
index cbc9399f3..fac3eb816 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitSshUntagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitSshUntagCommandTckTest.java
@@ -33,9 +33,6 @@
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
-/**
- *
- */
public abstract class GitSshUntagCommandTckTest extends UntagCommandTckTest {
protected final GitSshServer gitSshServer;
@@ -48,7 +45,9 @@ protected GitSshUntagCommandTckTest() throws GeneralSecurityException {
protected abstract String getScmProvider();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return "scm:" + getScmProvider() + ":ssh://localhost:" + gitSshServer.getPort() + "/repository";
}
@@ -63,7 +62,9 @@ protected void configureCredentials(ScmRepository repository, String passphrase)
providerRepository.setPassphrase(passphrase); // may be null
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
gitSshServer.start(getRepositoryRoot().getParentFile().toPath());
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitUntagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitUntagCommandTckTest.java
index acf5abed3..1791136d4 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitUntagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/untag/GitUntagCommandTckTest.java
@@ -35,9 +35,13 @@
import static org.junit.Assert.assertFalse;
-/** {@inheritDoc} */
+/**
+ * {@inheritDoc}
+ */
public abstract class GitUntagCommandTckTest extends UntagCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingDirectory());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateCommandTckTest.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateCommandTckTest.java
index 58d5eb3ca..804a3f224 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/command/update/GitUpdateCommandTckTest.java
@@ -27,10 +27,11 @@
/**
* @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
- *
*/
public abstract class GitUpdateCommandTckTest extends UpdateCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
GitScmTestUtils.initRepo("src/test/resources/repository/", getRepositoryRoot(), getWorkingCopy());
}
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommand.java
index e702e9eb1..614a680e9 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommand.java
@@ -35,15 +35,15 @@
import org.eclipse.jgit.util.FS;
/**
- * TODO Add javadoc
+ * TODO Add javadoc.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
public class GitPackCommand extends AbstractGitCommand {
/**
- * @param rootDirResolver Resolver for GIT root directory
- * @param command Command to execute
- * @param executorService An {@link CloseableExecutorService} to be used when
+ * @param rootDirResolver resolver for GIT root directory
+ * @param command command to execute
+ * @param executorService an {@link CloseableExecutorService} to be used when
* {@code start(ChannelSession, Environment)}-ing execution. If {@code null} an ad-hoc
* single-threaded service is created and used.
*/
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommandFactory.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommandFactory.java
index 292d98386..ea5e6bc42 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommandFactory.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gittest/src/main/java/org/apache/maven/scm/provider/git/sshd/git/pack/GitPackCommandFactory.java
@@ -26,7 +26,7 @@
import org.apache.sshd.server.command.CommandFactory;
/**
- * TODO Add javadoc
+ * TODO Add javadoc.
*
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</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/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 0b73aad58..b0c852c4a 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
@@ -90,8 +90,9 @@ private JGitUtils() {
/**
* Opens a JGit repository in the current directory or a parent directory.
- * @param basedir The directory to start with
- * @throws IOException If the repository cannot be opened
+ *
+ * @param basedir the directory to start with
+ * @throws IOException if the repository cannot be opened
*/
public static Git openRepo(File basedir) throws IOException {
return new Git(new RepositoryBuilder()
@@ -102,7 +103,8 @@ public static Git openRepo(File basedir) throws IOException {
}
/**
- * Closes the repository wrapped by the passed git object
+ * Closes the repository wrapped by the passed git object.
+ *
* @param git
*/
public static void closeRepo(Git git) {
@@ -129,7 +131,7 @@ public static ProgressMonitor getMonitor() {
*
* @param git the instance to configure (only in memory, not saved)
* @param repository the repo config to be used
- * @return {@link CredentialsProvider} in case credential information is configured in the repository.
+ * @return {@link CredentialsProvider} in case credential information is configured in the repository
*/
public static CredentialsProvider prepareSession(Git git, GitScmProviderRepository repository) {
StoredConfig config = git.getRepository().getConfig();
@@ -205,15 +207,15 @@ public static boolean hasCommits(Repository repo) {
}
/**
- * get a list of all files in the given commit
+ * Get a list of all files in the given commit.
*
* @param repository the repo
* @param commit the commit to get the files from
* @return a list of files included in the commit
- * @throws MissingObjectException
- * @throws IncorrectObjectTypeException
* @throws CorruptObjectException
+ * @throws IncorrectObjectTypeException
* @throws IOException
+ * @throws MissingObjectException
*/
public static List<ScmFile> getFilesInCommit(Repository repository, RevCommit commit)
throws MissingObjectException, IncorrectObjectTypeException, CorruptObjectException, IOException {
@@ -221,18 +223,17 @@ public static List<ScmFile> getFilesInCommit(Repository repository, RevCommit co
}
/**
- * get a list of all files in the given commit
+ * Get a list of all files in the given commit.
*
* @param repository the repo
* @param commit the commit to get the files from
* @param baseDir the directory to which the returned files should be relative.
* May be {@code null} in case they should be relative to the working directory root.
* @return a list of files included in the commit
- *
- * @throws MissingObjectException
- * @throws IncorrectObjectTypeException
* @throws CorruptObjectException
+ * @throws IncorrectObjectTypeException
* @throws IOException
+ * @throws MissingObjectException
*/
public static List<ScmFile> getFilesInCommit(Repository repository, RevCommit commit, File baseDir)
throws MissingObjectException, IncorrectObjectTypeException, CorruptObjectException, IOException {
@@ -336,6 +337,7 @@ public static List<ScmFile> removeAllFiles(Git git, ScmFileSet fileSet) throws G
/**
* Convert each file in the {@code fileSet} to their relative file path to workingCopyDirectory
* and return them in a list.
+ *
* @param workingCopyDirectory the working copy root directory
* @param fileSet the file set to convert
*/
@@ -352,7 +354,8 @@ public static List<File> getWorkingCopyRelativePaths(File workingCopyDirectory,
}
/**
- * Converts the given file to a string only containing forward slashes
+ * Converts the given file to a string only containing forward slashes.
+ *
* @param file
* @return the normalized file path
*/
@@ -395,9 +398,9 @@ private static File relativize(File baseDir, File file) {
* @param toDate until which date
* @param maxLines max number of lines
* @return a list of commits, might be empty, but never <code>null</code>
+ * @throws IncorrectObjectTypeException
* @throws IOException
* @throws MissingObjectException
- * @throws IncorrectObjectTypeException
*/
public static List<RevCommit> getRevCommits(
Repository repo,
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/PlexusInteractivityCredentialsProvider.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/PlexusInteractivityCredentialsProvider.java
index f7b3dae31..56348c224 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/PlexusInteractivityCredentialsProvider.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/PlexusInteractivityCredentialsProvider.java
@@ -29,7 +29,6 @@
/**
* {@link CredentialsProvider} leveraging the {@link Prompter} component.
- *
*/
public class PlexusInteractivityCredentialsProvider extends CredentialsProvider {
private boolean interactive;
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/ScmProviderAwareSshdSessionFactory.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/ScmProviderAwareSshdSessionFactory.java
index 8fda08f00..d6658bca8 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/ScmProviderAwareSshdSessionFactory.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/ScmProviderAwareSshdSessionFactory.java
@@ -36,7 +36,6 @@
/**
* {@link SshdSessionFactory} considering the settings from {@link GitScmProviderRepository}.
- *
*/
public class ScmProviderAwareSshdSessionFactory extends SshdSessionFactory {
private final GitScmProviderRepository repo;
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/branch/JGitBranchCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/branch/JGitBranchCommand.java
index 30c238bf6..624306a25 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/branch/JGitBranchCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/branch/JGitBranchCommand.java
@@ -142,7 +142,7 @@ protected ScmResult executeBranchCommand(
}
/**
- * gets a set of names of the available branches in the given repo
+ * Gets a set of names of the available branches in the given repo.
*
* @param git the repo to list the branches for
* @return set of short branch names
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/changelog/JGitChangeLogCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/changelog/JGitChangeLogCommand.java
index b32ae91d1..1c34718ba 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/changelog/JGitChangeLogCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/changelog/JGitChangeLogCommand.java
@@ -195,9 +195,6 @@ public List<ChangeEntry> whatchanged(
return changes;
}
- /**
- *
- */
public static final class ChangeEntry {
private String commitHash;
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/untag/JGitUntagCommand.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/untag/JGitUntagCommand.java
index 2a0e22d75..55668e051 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/untag/JGitUntagCommand.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/untag/JGitUntagCommand.java
@@ -45,7 +45,9 @@
import org.eclipse.jgit.transport.RemoteRefUpdate;
import org.slf4j.Logger;
-/** {@inheritDoc} */
+/**
+ * {@inheritDoc}
+ */
public class JGitUntagCommand extends AbstractUntagCommand implements GitCommand, CustomizableSshSessionFactoryCommand {
private BiFunction<GitScmProviderRepository, Logger, ScmProviderAwareSshdSessionFactory> sshSessionFactorySupplier;
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/AbstractSvnScmProvider.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/AbstractSvnScmProvider.java
index 79e561140..652f7810a 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/AbstractSvnScmProvider.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/AbstractSvnScmProvider.java
@@ -54,10 +54,9 @@
import org.apache.maven.scm.repository.UnknownRepositoryStructure;
/**
- * SCM Provider for Subversion
+ * SCM Provider for Subversion.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class AbstractSvnScmProvider extends AbstractScmProvider {
// ----------------------------------------------------------------------
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnChangeSet.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnChangeSet.java
index c645f3d4e..adcca79be 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnChangeSet.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnChangeSet.java
@@ -30,7 +30,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnChangeSet extends ChangeSet {
@@ -48,7 +47,9 @@ public SvnChangeSet(Date date, String comment, String author, List<ChangeFile> f
super(date, comment, author, files);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public boolean containsFilename(String filename, ScmProviderRepository repository) {
SvnScmProviderRepository repo = (SvnScmProviderRepository) repository;
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 01725979b..02fe7a2e3 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
@@ -22,7 +22,6 @@
* Command utilities for svn commands.
*
* @author <a href="mailto:jerome@coffeebreaks.org">Jerome Lacoste</a>
- *
*/
public final class SvnCommandUtils {
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnConfigFileReader.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnConfigFileReader.java
index a6986dc4a..c5b36ae95 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnConfigFileReader.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/SvnConfigFileReader.java
@@ -33,7 +33,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnConfigFileReader {
private File configDirectory;
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 6e2699e40..49bde5002 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
@@ -24,9 +24,6 @@
import org.apache.maven.scm.ScmVersion;
import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
-/**
- *
- */
public final class SvnTagBranchUtils {
private SvnTagBranchUtils() {}
@@ -44,7 +41,7 @@ private SvnTagBranchUtils() {}
/**
* Simple helper function to concatenate two paths together with a "/".
* Handles trailing / on basePath.
- * Returns no trailing "/" if the addlPath is null
+ * Returns no trailing "/" if the addlPath is null.
*/
static String appendPath(String basePath, String addlPath) {
basePath = StringUtils.stripEnd(basePath, "/");
@@ -59,9 +56,9 @@ static String appendPath(String basePath, String addlPath) {
/**
* Returns the project root for the given repository url,
* where "project root" is the root of the /trunk, /branches, /tags
- * directories
+ * directories.
*
- * @param repoPath Repository path/url to be searched
+ * @param repoPath repository path/url to be searched
* @return TODO
*/
public static String getProjectRoot(String repoPath) {
@@ -168,10 +165,10 @@ private static String addSuffix(String baseString, String suffix) {
* Else, the result is in the format of <code>projectRoot/subdir/branchTagName</code> directory.<br>
*
* @param repositoryUrl string url for the repository
- * @param tagBase tagBase to use.
- * @param subdir Subdirectory to append to the project root
+ * @param tagBase tagBase to use
+ * @param subdir subdirectory to append to the project root
* (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,
+ * @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 TODO
*/
@@ -243,7 +240,7 @@ private static boolean checkRevisionArg(String arg) {
* "PREV"
* <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
+ * IDENTIFIER:IDENTIFIER where IDENTIFIER is one of the args listed above.
*/
public static boolean isRevisionSpecifier(ScmVersion version) {
if (version == null) {
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/SvnCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/SvnCommand.java
index ce0283556..e3eb24720 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/SvnCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/SvnCommand.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public interface SvnCommand extends Command {
// no-op
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffConsumer.java
index 5846833e9..ba6a78887 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffConsumer.java
@@ -31,7 +31,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
*/
public class SvnDiffConsumer extends AbstractConsumer {
//
@@ -81,7 +80,9 @@ public SvnDiffConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (line.startsWith(INDEX_TOKEN)) {
// start a new file
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoItem.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoItem.java
index 79fb782e7..c554d84fe 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoItem.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoItem.java
@@ -22,7 +22,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
* @deprecated use {@link InfoItem}
*/
public class SvnInfoItem extends InfoItem {
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoScmResult.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoScmResult.java
index 83d129c14..f7e7301b0 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoScmResult.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
* @deprecated use {@link InfoScmResult}
*/
public class SvnInfoScmResult extends InfoScmResult {
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateScmResult.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateScmResult.java
index 011119a81..eb51a5b2f 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateScmResult.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateScmResult.java
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
* @deprecated
*/
public class SvnUpdateScmResult extends UpdateScmResultWithRevision {
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/repository/SvnScmProviderRepository.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/repository/SvnScmProviderRepository.java
index 8027aab4b..b54f5b5ed 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/repository/SvnScmProviderRepository.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/repository/SvnScmProviderRepository.java
@@ -24,10 +24,8 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnScmProviderRepository extends ScmProviderRepositoryWithHost {
- /** */
private String url;
private String protocol;
@@ -176,7 +174,9 @@ private void parseUrl(String url) {
}
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmProviderRepository getParent() {
String newUrl = getUrl().substring(getProtocol().length());
@@ -198,7 +198,9 @@ public ScmProviderRepository getParent() {
return new SvnScmProviderRepository(getProtocol() + newUrl, getUser(), getPassword());
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getRelativePath(ScmProviderRepository ancestor) {
if (ancestor instanceof SvnScmProviderRepository) {
SvnScmProviderRepository svnAncestor = (SvnScmProviderRepository) ancestor;
@@ -212,7 +214,9 @@ public String getRelativePath(ScmProviderRepository ancestor) {
return null;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String toString() {
return getUrl();
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/util/SvnUtil.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/util/SvnUtil.java
index b24920803..1206c02a0 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/util/SvnUtil.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/java/org/apache/maven/scm/provider/svn/util/SvnUtil.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnUtil {
protected static final String SVN_SETTINGS_FILENAME = "svn-settings.xml";
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/AbstractFileCheckingConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/AbstractFileCheckingConsumer.java
index 2a9e78bfd..906ef5e29 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/AbstractFileCheckingConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/AbstractFileCheckingConsumer.java
@@ -29,7 +29,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
*/
public abstract class AbstractFileCheckingConsumer extends AbstractConsumer {
protected File workingDirectory;
@@ -44,7 +43,9 @@ public AbstractFileCheckingConsumer(File workingDirectory) {
this.workingDirectory = workingDirectory;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public final void consumeLine(String line) {
if (line.length() <= 3) {
return;
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/SvnCommandLineUtils.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/SvnCommandLineUtils.java
index 27695bb1f..15792a393 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/SvnCommandLineUtils.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/SvnCommandLineUtils.java
@@ -40,7 +40,6 @@
*
* @author Brett Porter
* @author Olivier Lamy
- *
*/
public final class SvnCommandLineUtils {
private static final Logger LOGGER = LoggerFactory.getLogger(SvnCommandLineUtils.class);
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/add/SvnAddCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddCommand.java
index a8660fc12..1291414b2 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddCommand.java
@@ -37,10 +37,11 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnAddCommand extends AbstractAddCommand implements SvnCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeAddCommand(
ScmProviderRepository repository, ScmFileSet fileSet, String message, boolean binary) throws ScmException {
if (fileSet.getFileList().isEmpty()) {
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/add/SvnAddConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddConsumer.java
index d9695c32f..77ec4313b 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/add/SvnAddConsumer.java
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnAddConsumer extends AbstractConsumer {
private final List<ScmFile> addedFiles = new ArrayList<>();
@@ -36,7 +35,9 @@ public class SvnAddConsumer extends AbstractConsumer {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (line.length() <= 3) {
if (logger.isWarnEnabled()) {
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 60e823394..f8d0edfcf 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
@@ -48,8 +48,7 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
- * TODO since this is just a copy, use that instead.
+ * TODO since this is just a copy, use that instead
*/
public class SvnBranchCommand extends AbstractBranchCommand implements SvnCommand {
private final boolean interactive;
@@ -132,7 +131,9 @@ public ScmResult executeBranchCommand(
return new BranchScmResult(cl.toString(), fileList);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeBranchCommand(ScmProviderRepository repo, ScmFileSet fileSet, String branch, String message)
throws ScmException {
ScmBranchParameters scmBranchParameters = new ScmBranchParameters(message);
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/changelog/IllegalOutputException.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/IllegalOutputException.java
index 4be83950f..b50f51e83 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/IllegalOutputException.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/IllegalOutputException.java
@@ -20,6 +20,7 @@
/**
* Thrown when the output of an svn log command isn't recognized.
+ *
* @since 1.3
*/
@SuppressWarnings("serial")
@@ -28,7 +29,7 @@ public class IllegalOutputException extends RuntimeException {
/**
* Create the exception with a message.
*
- * @param message the message.
+ * @param message the message
*/
public IllegalOutputException(final String message) {
super(message);
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/changelog/SvnChangeLogCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogCommand.java
index 720831ef3..8dd70913a 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogCommand.java
@@ -50,7 +50,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class SvnChangeLogCommand extends AbstractChangeLogCommand implements SvnCommand {
private static final String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss Z";
@@ -75,7 +74,9 @@ public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fil
parameters.getInt(CommandParameter.LIMIT, -1));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Deprecated
@Override
protected ChangeLogScmResult executeChangeLogCommand(
@@ -88,7 +89,9 @@ protected ChangeLogScmResult executeChangeLogCommand(
return executeChangeLogCommand(repo, fileSet, null, null, null, datePattern, startVersion, endVersion, null);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Deprecated
@Override
protected ChangeLogScmResult executeChangeLogCommand(
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/changelog/SvnChangeLogConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogConsumer.java
index 33fc999da..37f239a1a 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/changelog/SvnChangeLogConsumer.java
@@ -32,7 +32,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnChangeLogConsumer extends AbstractConsumer {
/**
@@ -41,22 +40,22 @@ public class SvnChangeLogConsumer extends AbstractConsumer {
private static final String SVN_TIMESTAMP_PATTERN = "yyyy-MM-dd HH:mm:ss zzzzzzzzz";
/**
- * State machine constant: expecting header
+ * State machine constant: expecting header.
*/
private static final int GET_HEADER = 1;
/**
- * State machine constant: expecting file information
+ * State machine constant: expecting file information.
*/
private static final int GET_FILE = 2;
/**
- * State machine constant: expecting comments
+ * State machine constant: expecting comments.
*/
private static final int GET_COMMENT = 3;
/**
- * There is always action and affected path; when copying/moving, recognize also original path and revision
+ * There is always action and affected path; when copying/moving, recognize also original path and revision.
*/
private static final Pattern FILE_PATTERN = Pattern.compile("^\\s\\s\\s([A-Z])\\s(.+)$");
@@ -67,43 +66,43 @@ public class SvnChangeLogConsumer extends AbstractConsumer {
private static final Pattern ORIG_FILE_PATTERN = Pattern.compile("\\([A-Za-z]+ (.+):(\\d+)\\)");
/**
- * The file section ends with a blank line
+ * The file section ends with a blank line.
*/
private static final String FILE_END_TOKEN = "";
/**
- * The comment section ends with a dashed line
+ * The comment section ends with a dashed line.
*/
private static final String COMMENT_END_TOKEN =
"------------------------------------" + "------------------------------------";
/**
- * Current status of the parser
+ * Current status of the parser.
*/
private int status = GET_HEADER;
/**
- * List of change log entries
+ * List of change log entries.
*/
private final List<ChangeSet> entries = new ArrayList<>();
/**
- * The current log entry being processed by the parser
+ * The current log entry being processed by the parser.
*/
private SvnChangeSet currentChange;
/**
- * The current revision of the entry being processed by the parser
+ * The current revision of the entry being processed by the parser.
*/
private String currentRevision;
/**
- * The current comment of the entry being processed by the parser
+ * The current comment of the entry being processed by the parser.
*/
private StringBuilder currentComment;
/**
- * The regular expression used to match header lines
+ * The regular expression used to match header lines.
*/
private static final Pattern HEADER_REG_EXP = Pattern.compile("^(.+) \\| (.+) \\| (.+) \\|.*$");
@@ -172,7 +171,7 @@ public void consumeLine(String line) {
* repository is given a single revision number, which is used for
* the revision number of each file.
*
- * @param line A line of text from the svn log output
+ * @param line a line of text from the svn log output
*/
private void processGetHeader(String line) {
Matcher matcher = HEADER_REG_EXP.matcher(line);
@@ -217,7 +216,7 @@ private String getRevision(final String revisionOutput) {
* the revision number for the entire entry is used for the revision
* number of each file.
*
- * @param line A line of text from the svn log output
+ * @param line a line of text from the svn log output
*/
private void processGetFile(String line) {
Matcher matcher = FILE_PATTERN.matcher(line);
@@ -292,8 +291,8 @@ private void processGetComment(String line) {
* Converts the date time stamp from the svn output into a date
* object.
*
- * @param dateOutput The date output from an svn log command.
- * @return A date representing the time stamp of the log entry.
+ * @param dateOutput the date output from an svn log command
+ * @return a date representing the time stamp of the log entry
*/
private Date getDate(final String dateOutput) {
Matcher matcher = DATE_REG_EXP.matcher(dateOutput);
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/checkin/SvnCheckInCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInCommand.java
index f177817a1..c12f6b632 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInCommand.java
@@ -40,7 +40,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class SvnCheckInCommand extends AbstractCheckInCommand implements SvnCommand {
private final boolean interactive;
@@ -49,7 +48,9 @@ public SvnCheckInCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected CheckInScmResult executeCheckInCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String message, ScmVersion version) throws ScmException {
if (version != null && StringUtils.isNotEmpty(version.getName())) {
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/checkin/SvnCheckInConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInConsumer.java
index 0743037b1..20ced6977 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkin/SvnCheckInConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class SvnCheckInConsumer extends AbstractFileCheckingConsumer {
private static final String SENDING_TOKEN = "Sending ";
@@ -55,7 +54,9 @@ public SvnCheckInConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void parseLine(String line) {
String file;
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/checkout/SvnCheckOutCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutCommand.java
index ea34abae4..831303905 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutCommand.java
@@ -43,7 +43,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author Olivier Lamy
- *
*/
public class SvnCheckOutCommand extends AbstractCheckOutCommand implements SvnCommand {
private final boolean interactive;
@@ -113,7 +112,7 @@ protected CheckOutScmResult executeCheckOutCommand(
* @param workingDirectory not null
* @param version not null
* @param url not null
- * @return the SVN command line for the SVN check out.
+ * @return the SVN command line for the SVN check out
* @see #createCommandLine(SvnScmProviderRepository, File, ScmVersion, String, boolean)
*/
public Commandline createCommandLine(
@@ -128,8 +127,8 @@ public Commandline createCommandLine(
* @param workingDirectory not null
* @param version not null
* @param url not null
- * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise.
- * @return the SVN command line for the SVN check out.
+ * @param recursive <code>true</code> if recursive check out is wanted, <code>false</code> otherwise
+ * @return the SVN command line for the SVN check out
* @since 1.1.1
*/
public Commandline createCommandLine(
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/checkout/SvnCheckOutConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutConsumer.java
index 094dd9d14..9bef23a20 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/checkout/SvnCheckOutConsumer.java
@@ -30,7 +30,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @author Olivier Lamy
- *
*/
public class SvnCheckOutConsumer extends AbstractFileCheckingConsumer {
private static final String CHECKED_OUT_REVISION_TOKEN = "Checked out revision";
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/diff/SvnDiffCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/diff/SvnDiffCommand.java
index ead6d64ec..d5ec9df59 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/diff/SvnDiffCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/diff/SvnDiffCommand.java
@@ -39,7 +39,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
*/
public class SvnDiffCommand extends AbstractDiffCommand implements SvnCommand {
private final boolean interactive;
@@ -48,7 +47,9 @@ public SvnDiffCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected DiffScmResult executeDiffCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion startVersion, ScmVersion endVersion)
throws ScmException {
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/export/SvnExeExportCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/export/SvnExeExportCommand.java
index 95ae21ec1..d1dabf149 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/export/SvnExeExportCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/export/SvnExeExportCommand.java
@@ -44,7 +44,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnExeExportCommand extends AbstractExportCommand implements SvnCommand {
private final boolean interactive;
@@ -53,7 +52,9 @@ public SvnExeExportCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ExportScmResult executeExportCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version, String outputDirectory)
throws ScmException {
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/info/SvnInfoCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoCommand.java
index 3c165dd6c..4ca01a4b3 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoCommand.java
@@ -38,7 +38,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
*/
public class SvnInfoCommand extends AbstractCommand implements SvnCommand {
private final boolean interactive;
@@ -47,7 +46,9 @@ public SvnInfoCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeCommand(
ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
return executeInfoCommand((SvnScmProviderRepository) repository, fileSet, parameters, false, null);
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/info/SvnInfoConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoConsumer.java
index 453023571..ea4ede574 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/info/SvnInfoConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:kenney@apache.org">Kenney Westerhof</a>
- *
*/
public class SvnInfoConsumer extends AbstractConsumer {
private final List<InfoItem> infoItems = new ArrayList<>();
@@ -37,7 +36,9 @@ public class SvnInfoConsumer extends AbstractConsumer {
private static final DateTimeFormatter DT_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss Z");
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String s) {
if (s.equals("")) {
if (currentItem != null) {
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/list/SvnListCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListCommand.java
index 0866ea557..e00625fab 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListCommand.java
@@ -41,7 +41,6 @@
* Command to list files in SVN ( <code>svn list</code> command )
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class SvnListCommand extends AbstractListCommand implements SvnCommand {
private static final File TMP_DIR = new File(System.getProperty("java.io.tmpdir"));
@@ -51,7 +50,9 @@ public SvnListCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ListScmResult executeListCommand(
ScmProviderRepository repository, ScmFileSet fileSet, boolean recursive, ScmVersion version)
throws ScmException {
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/list/SvnListConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListConsumer.java
index 7536110ab..43293eb42 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/list/SvnListConsumer.java
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class SvnListConsumer extends AbstractConsumer {
private final List<ScmFile> files = new ArrayList<>();
@@ -36,7 +35,9 @@ public class SvnListConsumer extends AbstractConsumer {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
files.add(new ScmFile(line, ScmFileStatus.CHECKED_IN));
}
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/mkdir/SvnMkdirCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirCommand.java
index 2ff5299fb..cd16d9296 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirCommand.java
@@ -39,7 +39,6 @@
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public class SvnMkdirCommand extends AbstractMkdirCommand implements SvnCommand {
private final boolean interactive;
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/mkdir/SvnMkdirConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirConsumer.java
index 027fccd77..8c1bdf584 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/mkdir/SvnMkdirConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public class SvnMkdirConsumer extends AbstractConsumer {
private static final String COMMITTED_REVISION_TOKEN = "Committed revision";
@@ -37,7 +36,9 @@ public class SvnMkdirConsumer extends AbstractConsumer {
private final List<ScmFile> createdDirs = new ArrayList<>();
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (StringUtils.isBlank(line)) {
return;
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/remove/SvnRemoveCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveCommand.java
index 369931fd6..122375c9e 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveCommand.java
@@ -38,10 +38,11 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
*/
public class SvnRemoveCommand extends AbstractRemoveCommand implements SvnCommand {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ScmResult executeRemoveCommand(ScmProviderRepository repository, ScmFileSet fileSet, String message)
throws ScmException {
if (fileSet.getFileList().isEmpty()) {
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/remove/SvnRemoveConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveConsumer.java
index 8e3c28484..97d539425 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/remove/SvnRemoveConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
*/
public class SvnRemoveConsumer extends AbstractConsumer {
private final List<ScmFile> removedFiles = new ArrayList<>();
@@ -37,7 +36,9 @@ public class SvnRemoveConsumer extends AbstractConsumer {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (line.length() <= 3) {
if (logger.isWarnEnabled()) {
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/status/SvnStatusCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusCommand.java
index fb3b21d1f..71719178a 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusCommand.java
@@ -33,7 +33,6 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnStatusCommand extends AbstractStatusCommand implements SvnCommand {
@@ -43,7 +42,9 @@ public SvnStatusCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected StatusScmResult executeStatusCommand(ScmProviderRepository repo, ScmFileSet fileSet) throws ScmException {
Commandline cl = createCommandLine((SvnScmProviderRepository) repo, fileSet);
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/status/SvnStatusConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusConsumer.java
index 0dba6f021..b99a0037c 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/status/SvnStatusConsumer.java
@@ -28,7 +28,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class SvnStatusConsumer extends AbstractConsumer {
private final File workingDirectory;
@@ -47,7 +46,9 @@ public SvnStatusConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void consumeLine(String line) {
if (logger.isDebugEnabled()) {
logger.debug(line);
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 45c7e011e..e8d7e97be 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
@@ -49,8 +49,7 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author Olivier Lamy
- *
- * TODO since this is just a copy, use that instead.
+ * TODO since this is just a copy, use that instead
*/
public class SvnTagCommand extends AbstractTagCommand implements SvnCommand {
private final boolean interactive;
@@ -68,7 +67,9 @@ public ScmResult executeTagCommand(ScmProviderRepository repo, ScmFileSet fileSe
return executeTagCommand(repo, fileSet, tag, scmTagParameters);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public ScmResult executeTagCommand(
ScmProviderRepository repo, ScmFileSet fileSet, String tag, ScmTagParameters scmTagParameters)
throws ScmException {
@@ -172,12 +173,12 @@ public ScmResult executeTagCommand(
// ----------------------------------------------------------------------
/**
- * @deprecated
* @param repository
* @param workingDirectory
* @param tag
* @param messageFile
* @return TODO
+ * @deprecated
*/
public Commandline createCommandLine(
SvnScmProviderRepository repository, File workingDirectory, String tag, File messageFile) {
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/untag/SvnUntagCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/untag/SvnUntagCommand.java
index 568345bc8..5e80f6f71 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/untag/SvnUntagCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/untag/SvnUntagCommand.java
@@ -41,7 +41,7 @@
import org.codehaus.plexus.util.cli.Commandline;
/**
- * scm:untag for provider svn is done by removing the tag dir
+ * Scm:untag for provider svn is done by removing the tag dir.
*
* @since 1.11.2
*/
@@ -53,7 +53,9 @@ public SvnUntagCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
@Override
public ScmResult executeUntagCommand(
ScmProviderRepository repo, ScmFileSet fileSet, ScmUntagParameters scmUntagParameters) throws ScmException {
@@ -114,13 +116,13 @@ public ScmResult executeUntagCommand(
}
/**
- * create command line from parameters
+ * Create command line from parameters.
*
* @param repo svn repo tu delete tag from
* @param fileSet file set containing base dir
* @param tag tag to delete
* @param messageFile file containing commit message
- * @return command line instance
+ * @return command line instance
*/
Commandline createCommandline(SvnScmProviderRepository repo, ScmFileSet fileSet, String tag, File messageFile) {
Commandline cl = SvnCommandLineUtils.getBaseSvnCommandLine(fileSet.getBasedir(), repo, interactive);
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/update/SvnUpdateCommand.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateCommand.java
index a5c3d17eb..2c73800e4 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateCommand.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateCommand.java
@@ -45,7 +45,6 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnUpdateCommand extends AbstractUpdateCommand implements SvnCommand {
private final boolean interactive;
@@ -54,7 +53,9 @@ public SvnUpdateCommand(boolean interactive) {
this.interactive = interactive;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected UpdateScmResult executeUpdateCommand(ScmProviderRepository repo, ScmFileSet fileSet, ScmVersion version)
throws ScmException {
Commandline cl = createCommandLine((SvnScmProviderRepository) repo, fileSet.getBasedir(), version);
@@ -149,7 +150,9 @@ public Commandline createCommandLine(
return cl;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected ChangeLogCommand getChangeLogCommand() {
return new SvnChangeLogCommand(interactive);
}
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/update/SvnUpdateConsumer.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateConsumer.java
index c7bac86da..881cda3fd 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateConsumer.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/src/main/java/org/apache/maven/scm/provider/svn/svnexe/command/update/SvnUpdateConsumer.java
@@ -31,7 +31,6 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class SvnUpdateConsumer extends AbstractFileCheckingConsumer {
private static final String UPDATED_TO_REVISION_TOKEN = "Updated to revision";
@@ -56,7 +55,9 @@ public SvnUpdateConsumer(File workingDirectory) {
// StreamConsumer Implementation
// ----------------------------------------------------------------------
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
protected void parseLine(String line) {
line = line.trim();
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/SvnScmTestUtils.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/SvnScmTestUtils.java
index c186e5f0d..2d87cd02d 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/SvnScmTestUtils.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/SvnScmTestUtils.java
@@ -31,13 +31,12 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public final class SvnScmTestUtils {
- /** 'svn' command line */
+ /** 'svn' command line. */
public static final String SVN_COMMAND_LINE = "svn";
- /** 'svnadmin' command line */
+ /** 'svnadmin' command line. */
public static final String SVNADMIN_COMMAND_LINE = "svnadmin";
private SvnScmTestUtils() {}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/branch/SvnBranchCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/branch/SvnBranchCommandTckTest.java
index 381529963..c9534c42b 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/branch/SvnBranchCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/branch/SvnBranchCommandTckTest.java
@@ -27,15 +27,18 @@
* This test tests the branch command.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnBranchCommandTckTest extends BranchCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkin/SvnCheckInCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkin/SvnCheckInCommandTckTest.java
index 63e75b4c5..0de654fa1 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkin/SvnCheckInCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkin/SvnCheckInCommandTckTest.java
@@ -25,15 +25,18 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnCheckInCommandTckTest extends CheckInCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkout/SvnCheckOutCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkout/SvnCheckOutCommandTckTest.java
index 21e24edd6..fc0299398 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkout/SvnCheckOutCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/checkout/SvnCheckOutCommandTckTest.java
@@ -25,15 +25,18 @@
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public class SvnCheckOutCommandTckTest extends CheckOutCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffCommandTckTest.java
index 1738b33f2..4ae356c90 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffCommandTckTest.java
@@ -25,15 +25,18 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnDiffCommandTckTest extends DiffCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoCommandTckTest.java
index 541c6d92c..5c1819a83 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/info/SvnInfoCommandTckTest.java
@@ -24,12 +24,16 @@
import org.apache.maven.scm.tck.command.info.InfoCommandTckTest;
public class SvnInfoCommandTckTest extends InfoCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
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 670a35e9b..251e51641 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
@@ -24,18 +24,21 @@
import org.apache.maven.scm.tck.command.list.ListCommandTckTest;
/**
- * Test for {@code list} command
+ * Test for {@code list} command.
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class SvnListCommandTckTest extends ListCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/mkdir/SvnMkdirCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/mkdir/SvnMkdirCommandTckTest.java
index 04f41b1e3..1dc1a199d 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/mkdir/SvnMkdirCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/mkdir/SvnMkdirCommandTckTest.java
@@ -33,15 +33,18 @@
/**
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public class SvnMkdirCommandTckTest extends MkdirCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/remove/SvnRemoveCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/remove/SvnRemoveCommandTckTest.java
index 6fbc4d62c..0cf3bf419 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/remove/SvnRemoveCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/remove/SvnRemoveCommandTckTest.java
@@ -23,16 +23,17 @@
import org.apache.maven.scm.provider.svn.SvnScmTestUtils;
import org.apache.maven.scm.tck.command.remove.RemoveCommandTckTest;
-/**
- *
- */
public class SvnRemoveCommandTckTest extends RemoveCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/status/SvnStatusCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/status/SvnStatusCommandTckTest.java
index 8b7ffdf86..9cbedc96a 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/status/SvnStatusCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/status/SvnStatusCommandTckTest.java
@@ -25,15 +25,18 @@
/**
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnStatusCommandTckTest extends StatusCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/tag/SvnTagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/tag/SvnTagCommandTckTest.java
index 0ad73b585..a9bee98e9 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/tag/SvnTagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/tag/SvnTagCommandTckTest.java
@@ -27,15 +27,18 @@
* This test tests the tag command.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnTagCommandTckTest extends TagCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/untag/SvnUntagCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/untag/SvnUntagCommandTckTest.java
index 2775d72de..084d01dc2 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/untag/SvnUntagCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/untag/SvnUntagCommandTckTest.java
@@ -27,15 +27,18 @@
* This test tests the tag command.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public class SvnUntagCommandTckTest extends UntagCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateCommandTckTest.java b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateCommandTckTest.java
index 71e627553..62fb54a06 100644
--- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateCommandTckTest.java
+++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svntest/src/main/java/org/apache/maven/scm/provider/svn/command/update/SvnUpdateCommandTckTest.java
@@ -25,15 +25,18 @@
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public class SvnUpdateCommandTckTest extends UpdateCommandTckTest {
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public String getScmUrl() throws Exception {
return SvnScmTestUtils.getScmUrl(new File(getRepositoryRoot(), "trunk"));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void initRepo() throws Exception {
SvnScmTestUtils.initializeRepository(getRepositoryRoot());
}
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 078a1deec..f11abfd56 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
@@ -52,7 +52,6 @@
* </ol>
*
* @author <a href="mailto:torbjorn@smorgrav.org">Torbj�rn Eikli Sm�rgrav</a>
- *
*/
public abstract class ScmTckTestCase extends ScmTestCase {
private ScmRepository scmRepository;
@@ -62,14 +61,15 @@ public abstract class ScmTckTestCase extends ScmTestCase {
/**
* Some tests can only run if the appropriate application has been installed.
* If the provided name is not a runnable application all tests in the class are skipped.
- * @return The commandline command for the specific scm provider. Or null if none is needed.
+ *
+ * @return the commandline command for the specific scm provider. Or null if none is needed.
*/
public String getScmProviderCommand() {
return null;
}
/**
- * @return A provider specific and valid url for the repository
+ * @return a provider specific and valid url for the repository
* @throws Exception if any
*/
public abstract String getScmUrl() throws Exception;
@@ -160,7 +160,7 @@ public void tearDown() throws Exception {
}
/**
- * Convenience method to get the ScmRepository for this provider
+ * Convenience method to get the ScmRepository for this provider.
*/
protected ScmRepository getScmRepository() throws Exception {
if (scmRepository == null) {
@@ -171,7 +171,7 @@ protected ScmRepository getScmRepository() throws Exception {
}
/**
- * Convenience method to check out files from the repository
+ * Convenience method to check out files from the repository.
*/
protected CheckOutScmResult checkOut(File workingDirectory, ScmRepository repository) throws Exception {
CheckOutScmResult result = getScmManager()
@@ -184,7 +184,7 @@ protected CheckOutScmResult checkOut(File workingDirectory, ScmRepository reposi
}
/**
- * Convenience method to check in files to the repository
+ * Convenience method to check in files to the repository.
*/
protected CheckInScmResult checkIn(File workingDirectory, ScmRepository repository) throws Exception {
CheckInScmResult result = getScmManager()
@@ -197,7 +197,7 @@ protected CheckInScmResult checkIn(File workingDirectory, ScmRepository reposito
}
/**
- * Convenience method to remove files from the repository
+ * Convenience method to remove files from the repository.
*/
protected RemoveScmResult remove(File workingDirectory, ScmRepository repository) throws Exception {
RemoveScmResult result = getScmManager()
@@ -210,7 +210,7 @@ protected RemoveScmResult remove(File workingDirectory, ScmRepository repository
}
/**
- * Convenience method to add a file to the working tree at the working directory
+ * Convenience method to add a file to the working tree at the working directory.
*/
protected void addToWorkingTree(File workingDirectory, File file, ScmRepository repository) throws Exception {
ScmProvider provider = getScmManager().getProviderByUrl(getScmUrl());
@@ -231,7 +231,7 @@ protected void addToWorkingTree(File workingDirectory, File file, ScmRepository
}
/**
- * take the files of the given list, add them to a TreeMap and
+ * Take the files of the given list, add them to a TreeMap and
* use the pathName String as key for the Map.
* This function is useful for every TCK which has to check for the
* existence of more than 1 file of the returned ScmResult, regardless
@@ -239,8 +239,8 @@ protected void addToWorkingTree(File workingDirectory, File file, ScmRepository
* All backslashes in the path will be replaced by forward slashes
* for Windows compatibility.
*
- * @param files List with {@code ScmFile}s
- * @return Map key=pathName, value=ScmFile
+ * @param files list with {@code ScmFile}s
+ * @return map key=pathName, value=ScmFile
*/
protected Map<String, ScmFile> mapFilesByPath(List<ScmFile> files) {
if (files == null) {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTestCase.java b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTestCase.java
index cf9c67dfa..8cf1294d7 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTestCase.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/ScmTestCase.java
@@ -50,7 +50,6 @@
* test environment and implements convenience methods.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
- *
*/
public abstract class ScmTestCase extends PlexusJUnit4TestCase {
protected static final TimeZone GMT_TIME_ZONE = TimeZone.getTimeZone("GMT");
@@ -91,7 +90,7 @@ protected File getRepositoryRoot() {
}
/**
- * @return Location of the revisioned (read only) repository
+ * @return location of the revisioned (read only) repository
*/
protected File getRepository() {
return PlexusJUnit4TestCase.getTestFile("/src/test/repository");
@@ -191,7 +190,7 @@ protected static void setDebugExecute(boolean debugExecute) {
}
/**
- * Execute the command line
+ * Execute the command line.
*
* @param workingDirectory not null
* @param executable not null, should be a system command
@@ -306,7 +305,7 @@ public static void checkSystemCmdPresence(String scmProviderCommand) {
}
/**
- * @param cmd the executable to run, not null.
+ * @param cmd the executable to run, not null
* @return true if and only if the command is on the path
*/
public static boolean isSystemCmd(String cmd) {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java b/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java
index 3ae1d9f68..c732cfbcb 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java
@@ -60,7 +60,6 @@
* <a href="https://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class ScmManagerStub implements ScmManager {
@@ -71,7 +70,7 @@ public class ScmManagerStub implements ScmManager {
private List<String> messages;
/**
- * Creates a new stub with stub repository and provider, and empty list of messages
+ * Creates a new stub with stub repository and provider, and empty list of messages.
*/
public ScmManagerStub() {
setScmRepository(new ScmRepositoryStub());
@@ -110,7 +109,7 @@ public ScmRepository getScmRepository() {
}
/**
- * Set the messages to return in validateScmRepository
+ * Set the messages to return in validateScmRepository.
*
* @param messages <code>List</code> of <code>String</code> objects
*/
@@ -119,7 +118,7 @@ public void setMessages(List<String> messages) {
}
/**
- * Get the messages to return in validateScmRepository
+ * Get the messages to return in validateScmRepository.
*
* @return <code>List</code> of <code>String</code> objects
*/
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryStub.java b/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryStub.java
index 0df0a8743..c999d59ca 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryStub.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderRepositoryStub.java
@@ -24,23 +24,26 @@
* <a href="https://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class ScmProviderRepositoryStub extends ScmProviderRepository {
private boolean persistCheckout = false;
/**
- * Creates a ScmProviderRepositoryStub with null user and password, and persistCheckout false
+ * Creates a ScmProviderRepositoryStub with null user and password, and persistCheckout false.
*/
public ScmProviderRepositoryStub() {}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public boolean isPersistCheckout() {
return persistCheckout;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ */
public void setPersistCheckout(boolean persistCheckout) {
this.persistCheckout = persistCheckout;
}
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderStub.java b/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderStub.java
index cc8ff3a19..59a1a84bf 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderStub.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/provider/ScmProviderStub.java
@@ -63,7 +63,6 @@
* <a href="https://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class ScmProviderStub implements ScmProvider {
@@ -110,7 +109,7 @@ public class ScmProviderStub implements ScmProvider {
private UntagScmResult untagScmResult;
/**
- * Create a new ScmProviderStub with bogus (not null) attributes
+ * Create a new ScmProviderStub with bogus (not null) attributes.
*/
public ScmProviderStub() {
setScmSpecificFilename("");
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java b/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java
index b0aae8bae..379c34d7d 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java
@@ -26,12 +26,11 @@
* <a href="https://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public class ScmRepositoryStub extends ScmRepository {
/**
- * Creates a new stub with a new ScmProviderRepositoryStub as scmProviderRepository
+ * Creates a new stub with a new ScmProviderRepositoryStub as scmProviderRepository.
*/
public ScmRepositoryStub() {
super("stub-provider", new ScmProviderRepositoryStub());
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/branch/BranchCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/branch/BranchCommandTckTest.java
index 5e742999b..8811df3ed 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/branch/BranchCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/branch/BranchCommandTckTest.java
@@ -41,7 +41,6 @@
* This test tests the branch command.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- *
*/
public abstract class BranchCommandTckTest extends ScmTckTestCase {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/changelog/ChangeLogCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/changelog/ChangeLogCommandTckTest.java
index 1f87adac8..ec8e181cb 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/changelog/ChangeLogCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/changelog/ChangeLogCommandTckTest.java
@@ -56,7 +56,8 @@ public abstract class ChangeLogCommandTckTest extends ScmTckTestCase {
/**
* In some SCMs (Hg) adding a tag creates an extra commit which offsets the expectations.
- * @return If an extra commit will be present for a tag.
+ *
+ * @return if an extra commit will be present for a tag
*/
public boolean isTagAnExtraCommit() {
return false;
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/checkout/CheckOutCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/checkout/CheckOutCommandTckTest.java
index 6eee767a8..3f76ecd0f 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/checkout/CheckOutCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/checkout/CheckOutCommandTckTest.java
@@ -34,7 +34,6 @@
* This test tests the check out command.
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class CheckOutCommandTckTest extends ScmTckTestCase {
@Test
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff/DiffCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff/DiffCommandTckTest.java
index b72896e8b..b2f500d96 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff/DiffCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff/DiffCommandTckTest.java
@@ -42,7 +42,6 @@
* This test tests the diff command.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public abstract class DiffCommandTckTest extends ScmTckTestCase {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/info/InfoCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/info/InfoCommandTckTest.java
index 964da970c..9648dfee2 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/info/InfoCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/info/InfoCommandTckTest.java
@@ -33,7 +33,6 @@
/**
* This test tests the info command.
- *
*/
public abstract class InfoCommandTckTest extends ScmTckTestCase {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/list/ListCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/list/ListCommandTckTest.java
index ad097eb28..c415d1940 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/list/ListCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/list/ListCommandTckTest.java
@@ -37,7 +37,6 @@
* This test tests the list command.
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
- *
*/
public abstract class ListCommandTckTest extends ScmTckTestCase {
@Test
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/mkdir/MkdirCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/mkdir/MkdirCommandTckTest.java
index 1097fdeee..171e0fd52 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/mkdir/MkdirCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/mkdir/MkdirCommandTckTest.java
@@ -32,7 +32,6 @@
* This test tests the mkdir command.
*
* @author <a href="mailto:oching@apache.org">Maria Odea Ching</a>
- *
*/
public abstract class MkdirCommandTckTest extends ScmTckTestCase {
@Test
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 090e88aa9..9cacb0b74 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
@@ -57,7 +57,6 @@
* </ol>
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public abstract class StatusCommandTckTest extends ScmTckTestCase {
diff --git a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/tag/TagCommandTckTest.java b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/tag/TagCommandTckTest.java
index c5a4106e4..6f7dadef2 100644
--- a/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/tag/TagCommandTckTest.java
+++ b/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/tag/TagCommandTckTest.java
@@ -41,7 +41,6 @@
* This test tests the tag command.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- *
*/
public abstract class TagCommandTckTest extends ScmTckTestCase {
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 b8ee9c8a1..e1310f2a7 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
@@ -58,7 +58,6 @@
* </ol>
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
- *
*/
public abstract class UpdateCommandTckTest extends ScmTckTestCase {