Author: dennisl
Date: Sun Oct 29 13:42:10 2006
New Revision: 469007
URL: http://svn.apache.org/viewvc?view=rev&rev=469007
Log:
o Adhere to JavaDoc conventions.
o Fix a couple of Checkstyle errors.
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/AbstractScmMojo.java
Sun Oct 29 13:42:10 2006
@@ -50,8 +50,8 @@
private String connectionUrl;
/**
- * The SCM connection URL for developers
- *
+ * The SCM connection URL for developers.
+ *
* @parameter expression="${connectionUrl}"
default-value="${project.scm.developerConnection}"
*/
private String developerConnectionUrl;
@@ -64,7 +64,7 @@
private String connectionType;
/**
- * The working directory
+ * The working directory.
*
* @parameter expression="${workingDirectory}"
*/
@@ -99,7 +99,9 @@
private String passphrase;
/**
- * The url of tags base directory (used by svn protocol). Not necessary to
set it if you use standard svn layout (branches/tags/trunk).
+ * The url of tags base directory (used by svn protocol). It is not
+ * necessary to set it if you use the standard svn layout
+ * (branches/tags/trunk).
*
* @parameter expression="${tagBase}"
*/
@@ -127,7 +129,7 @@
private ScmManager manager;
/**
- * The base directory
+ * The base directory.
*
* @parameter expression="${basedir}"
* @required
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/BootstrapMojo.java
Sun Oct 29 13:42:10 2006
@@ -30,7 +30,7 @@
import java.util.Properties;
/**
- * Pulls the project source from the configured scm and execute the configured
goals
+ * Pull the project source from the configured scm and execute the configured
goals.
*
* @author <a href="[EMAIL PROTECTED]">Dan T. Tran</a>
* @version $Id$
@@ -41,7 +41,6 @@
public class BootstrapMojo
extends CheckoutMojo
{
-
/**
* The goals to run on the clean checkout of a project for the bootstrap
goal.
* If none are specified, then the default goal for the project is
executed.
@@ -49,7 +48,6 @@
*
* @parameter expression="${goals}
*/
-
private String goals;
public void execute()
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ChangeLogMojo.java
Sun Oct 29 13:42:10 2006
@@ -31,7 +31,7 @@
import java.util.Iterator;
/**
- * Dump changelog contents to console. It is mainly used to test
maven-scm-api's changelog command
+ * Dump changelog contents to console. It is mainly used to test
maven-scm-api's changelog command.
*
* @author <a href="[EMAIL PROTECTED]">Dan Tran</a>
* @version $Id$
@@ -41,7 +41,7 @@
public class ChangeLogMojo
extends AbstractScmMojo
{
- private final static String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
+ private static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
/**
* Start Date.
@@ -51,14 +51,14 @@
private String startDate;
/**
- * End Date
+ * End Date.
*
* @parameter expression="${endDate}"
*/
private String endDate;
/**
- * Date Format in changelog output of scm tool
+ * Date Format in changelog output of scm tool.
*
* @parameter expression="${dateFormat}"
*/
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckinMojo.java
Sun Oct 29 13:42:10 2006
@@ -24,7 +24,7 @@
import java.io.IOException;
/**
- * commit changes to the configured scm url
+ * Commit changes to the configured scm url.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -35,14 +35,14 @@
extends AbstractScmMojo
{
/**
- * commit log
+ * Commit log.
*
* @parameter expression="${message}
*/
private String message;
/**
- * configured scm url to use
+ * The configured scm url to use.
*
* @parameter expression="${connectionType}"
default-value="developerConnection"
*/
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/CheckoutMojo.java
Sun Oct 29 13:42:10 2006
@@ -27,7 +27,7 @@
import java.io.IOException;
/**
- * get a fresh copy of the latest source from the configured scm url
+ * Get a fresh copy of the latest source from the configured scm url.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -39,7 +39,7 @@
extends AbstractScmMojo
{
/**
- * branch name
+ * Branch name.
*
* @parameter expression="${branch}
*/
@@ -53,7 +53,7 @@
private String tag;
/**
- * The directory to checkout the sources to for the bootstrap and checkout
goals
+ * The directory to checkout the sources to for the bootstrap and checkout
goals.
*
* @parameter expression="${checkoutDirectory}"
default-value="${project.build.directory}/checkout"
*/
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/DiffMojo.java
Sun Oct 29 13:42:10 2006
@@ -26,7 +26,7 @@
import java.io.IOException;
/**
- * displays the difference of the working copy with the latest copy in the
configured scm url
+ * Display the difference of the working copy with the latest copy in the
configured scm url.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -37,21 +37,21 @@
extends AbstractScmMojo
{
/**
- * Start revision id
+ * Start revision id.
*
* @parameter expression="${startRevision}
*/
private String startRevision;
/**
- * End revision id
+ * End revision id.
*
* @parameter expression="${endRevision}
*/
private String endRevision;
/**
- * Output file name
+ * Output file name.
*
* @parameter expression="${outputFile}"
* default-value="${project.artifactId}.diff"
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/EditMojo.java
Sun Oct 29 13:42:10 2006
@@ -24,7 +24,7 @@
import java.io.IOException;
/**
- * Edit/lock a set of files
+ * Edit/lock a set of files.
*
* @author <a href="[EMAIL PROTECTED]">Dan Tran</a>
* @version $Id$
@@ -34,7 +34,6 @@
public class EditMojo
extends AbstractScmMojo
{
-
public void execute()
throws MojoExecutionException
{
@@ -56,5 +55,4 @@
throw new MojoExecutionException( "Cannot run edit command : ", e
);
}
}
-
}
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/StatusMojo.java
Sun Oct 29 13:42:10 2006
@@ -28,7 +28,7 @@
import java.util.Iterator;
/**
- * Displays the modification status of the files in the configured scm url.
+ * Display the modification status of the files in the configured scm url.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -38,7 +38,6 @@
public class StatusMojo
extends AbstractScmMojo
{
-
public void execute()
throws MojoExecutionException
{
@@ -67,8 +66,8 @@
ScmFile file = (ScmFile) iter.next();
// right align all of the statuses
- getLog().info( StringUtils.leftPad(
file.getStatus().toString(), maxLen ) + " " +
- getRelativePath( baseDir, file.getPath() ) );
+ getLog().info( StringUtils.leftPad(
file.getStatus().toString(), maxLen ) + " "
+ + getRelativePath( baseDir, file.getPath() ) );
}
}
catch ( IOException e )
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java
Sun Oct 29 13:42:10 2006
@@ -26,7 +26,7 @@
import java.util.Date;
/**
- * tag the project
+ * Tag the project.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @author <a href="[EMAIL PROTECTED]">Sharmarke Aden</a>
@@ -36,30 +36,31 @@
* @description Tag the project
*/
public class TagMojo
- extends AbstractScmMojo {
+ extends AbstractScmMojo
+{
/**
- * tag name
+ * Tag name.
*
* @parameter expression="${tag}"
*/
private String tag;
/**
- * set the timestamp format
+ * Set the timestamp format.
*
* @parameter expression="${timestampFormat}"
default-value="yyyyMMddHHmmss"
*/
private String timestampFormat;
/**
- * use timestamp tagging
+ * Use timestamp tagging.
*
* @parameter expression="${addTimestamp}" default-value="false"
*/
private boolean addTimestamp;
/**
- * timestamp tag prefix
+ * Timestamp tag prefix.
*
* @parameter expression="${timestampPrefix}" default-value="-"
*/
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UnEditMojo.java
Sun Oct 29 13:42:10 2006
@@ -24,7 +24,7 @@
import java.io.IOException;
/**
- * Unedit/unlock a set of files
+ * Unedit/unlock a set of files.
*
* @author <a href="[EMAIL PROTECTED]">Dan Tran</a>
* @version $Id$
@@ -34,7 +34,6 @@
public class UnEditMojo
extends AbstractScmMojo
{
-
public void execute()
throws MojoExecutionException
{
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/UpdateMojo.java
Sun Oct 29 13:42:10 2006
@@ -26,7 +26,7 @@
import java.io.IOException;
/**
- * update the local working copy with the latest source from the configured
scm url
+ * Update the local working copy with the latest source from the configured
scm url.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -38,21 +38,21 @@
extends AbstractScmMojo
{
/**
- * branch name
+ * Branch name.
*
* @parameter expression="${branch}"
*/
private String branch;
/**
- * tag name
+ * Tag name.
*
* @parameter expression="${tag}"
*/
private String tag;
/**
- * The project property where to store the revision name
+ * The project property where to store the revision name.
*
* @parameter expression="${revisionKey}" default-value="scm.revision"
*/
Modified:
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java?view=diff&rev=469007&r1=469006&r2=469007
==============================================================================
---
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
(original)
+++
maven/scm/trunk/maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/ValidateMojo.java
Sun Oct 29 13:42:10 2006
@@ -22,7 +22,7 @@
import java.util.List;
/**
- * Validate scm connection string
+ * Validate scm connection string.
*
* @author <a href="[EMAIL PROTECTED]">Emmanuel Venisse</a>
* @version $Id$
@@ -34,14 +34,14 @@
extends AbstractScmMojo
{
/**
- * scm connection url
+ * The scm connection url.
*
* @parameter expression="${scmConnection}"
default-value="${project.scm.connection}"
*/
private String scmConnection;
/**
- * scm connection url for developers
+ * The scm connection url for developers.
*
* @parameter expression="${scmDeveloperConnection}"
default-value="${project.scm.developerConnection}"
*/
@@ -57,7 +57,7 @@
}
catch ( NullPointerException e )
{
- // nothing to do. connectionUrl isn't define
+ // nothing to do. connectionUrl isn't defined
}
//check scm connection
