svn commit: r754680 - in /maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install: AbstractInstallMojo.java InstallFileMojo.java

[dennisl]

Author: dennisl
Date: Sun Mar 15 15:52:53 2009
New Revision: 754680

URL: http://svn.apache.org/viewvc?rev=754680&view=rev
Log:
o Add @since tags to parameters.

Modified:
    
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
    
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java

Modified: 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java?rev=754680&r1=754679&r2=754680&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
 Sun Mar 15 15:52:53 2009
@@ -66,19 +66,20 @@
      * Flag whether to create checksums (MD5, SHA-1) or not.
      *
      * @parameter expression="${createChecksum}" default-value="false"
+     * @since 2.2
      */
     protected boolean createChecksum;
 
     /**
      * Digester for MD5.
-     * 
+     *
      * @component role-hint="md5"
      */
     protected Digester md5Digester;
 
     /**
      * Digester for SHA-1.
-     * 
+     *
      * @component role-hint="sha1"
      */
     protected Digester sha1Digester;
@@ -86,7 +87,7 @@
     /**
      * Gets the path of the specified artifact within the local repository. 
Note that the returned path need not exist
      * (yet).
-     * 
+     *
      * @param artifact The artifact whose local repo path should be 
determined, must not be <code>null</code>.
      * @return The absolute path to the artifact when installed, never 
<code>null</code>.
      */
@@ -99,7 +100,7 @@
     /**
      * Gets the path of the specified artifact metadata within the local 
repository. Note that the returned path need
      * not exist (yet).
-     * 
+     *
      * @param metadata The artifact metadata whose local repo path should be 
determined, must not be <code>null</code>.
      * @return The absolute path to the artifact metadata when installed, 
never <code>null</code>.
      */
@@ -116,7 +117,7 @@
      * <code>ProjectArtifactMetadata</code> did not install the original POM 
file (cf. MNG-2820). While the plugin
      * currently requires Maven 2.0.6, we continue to hash the installed POM 
for robustness with regard to future
      * changes like re-introducing some kind of POM filtering.
-     * 
+     *
      * @param artifact The artifact for which to create checksums, must not be 
<code>null</code>.
      * @throws MojoExecutionException If the checksums could not be installed.
      */
@@ -145,7 +146,7 @@
 
     /**
      * Installs the checksums for the specified file (if it exists).
-     * 
+     *
      * @param installedFile The path to the already installed file in the 
local repo for which to generate checksums,
      *            must not be <code>null</code>.
      * @throws MojoExecutionException If the checksums could not be installed.
@@ -163,7 +164,7 @@
 
     /**
      * Installs a checksum for the specified file.
-     * 
+     *
      * @param originalFile The path to the file from which the checksum is 
generated, must not be <code>null</code>.
      * @param installedFile The base path from which the path to the checksum 
files is derived by appending the given
      *            file extension, must not be <code>null</code>.

Modified: 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java?rev=754680&r1=754679&r2=754680&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
 Sun Mar 15 15:52:53 2009
@@ -91,6 +91,7 @@
      * means this is the project's main artifact.
      *
      * @parameter expression="${classifier}"
+     * @since 2.2
      */
     protected String classifier;
 
@@ -123,6 +124,7 @@
      * parameter.
      *
      * @parameter expression="${pomFile}"
+     * @since 2.1
      */
     private File pomFile;
 
@@ -131,6 +133,7 @@
      * <code>true</code> if there is no existing POM in the local repository 
yet.
      *
      * @parameter expression="${generatePom}"
+     * @since 2.1
      */
     private Boolean generatePom;
 
@@ -140,6 +143,7 @@
      *
      * @parameter expression="${repositoryLayout}" default-value="default"
      * @required
+     * @since 2.2
      */
     private String repositoryLayout;
 
@@ -155,6 +159,7 @@
      * <code>localRepoId</code> as <code>id</code> and with a default 
<code>repositoryLayout</code>.
      *
      * @parameter expression="${localRepositoryPath}"
+     * @since 2.2
      */
     private File localRepositoryPath;
 
@@ -162,6 +167,7 @@
      * The <code>id</code> for the <code>localRepo</code>.
      *
      * @parameter expression="${localRepositoryId}"
+     * @since 2.2
      */
     private String localRepositoryId;