Author: jdcasey
Date: Mon Jun  5 21:18:30 2006
New Revision: 411990

URL: http://svn.apache.org/viewvc?rev=411990&view=rev
Log:
o Added parameter documentation
o Removed @readonly from the generatePom parameter, to make consistent with the 
provision of an expression annotation
o Added a default-value of "remote-repository" to the repositoryId parameter

Modified:
    
maven/plugins/trunk/maven-deploy-plugin/src/main/java/org/apache/maven/plugin/deploy/DeployFileMojo.java

Modified: 
maven/plugins/trunk/maven-deploy-plugin/src/main/java/org/apache/maven/plugin/deploy/DeployFileMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-deploy-plugin/src/main/java/org/apache/maven/plugin/deploy/DeployFileMojo.java?rev=411990&r1=411989&r2=411990&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-deploy-plugin/src/main/java/org/apache/maven/plugin/deploy/DeployFileMojo.java
 (original)
+++ 
maven/plugins/trunk/maven-deploy-plugin/src/main/java/org/apache/maven/plugin/deploy/DeployFileMojo.java
 Mon Jun  5 21:18:30 2006
@@ -95,14 +95,17 @@
 
     /**
      * Server Id to map on the <id> under <server> section of 
settings.xml
+     * In most cases, this parameter will be required for authentication.
      *
-     * @parameter expression="${repositoryId}"
+     * @parameter expression="${repositoryId}" 
default-value="remote-repository"
      * @required
      */
     private String repositoryId;
 
     /**
-     * The type of remote repository layout to deploy to. Try <i>legacy</i> 
for a Maven 1.x-style repository layout.
+     * The type of remote repository layout to deploy to. Try <i>legacy</i> 
for 
+     * a Maven 1.x-style repository layout.
+     * 
      * @parameter expression="${repositoryLayout}" default-value="default"
      * @required
      */
@@ -115,7 +118,7 @@
 
     /**
      * URL where the artifact will be deployed. <br/>
-     * ie ( file://C:\m2-repo )
+     * ie ( file://C:\m2-repo or scp://host.com/path/to/repo )
      *
      * @parameter expression="${url}"
      * @required
@@ -133,6 +136,9 @@
     private ArtifactRepositoryFactory repositoryFactory;
 
     /**
+     * Location of an existing POM file to be deployed alongside the main
+     * artifact, given by the ${file} parameter.
+     * 
      * @parameter expression="${pomFile}"
      */
     private File pomFile;
@@ -141,10 +147,9 @@
      * Upload a POM for this artifact.  Will generate a default POM if none is
      * supplied with the pomFile argument.
      *
-     * @parameter expression="${generatePom}"
-     * @readonly
+     * @parameter expression="${generatePom}" default-value="true"
      */
-    private boolean generatePom = true;
+    private boolean generatePom;
 
     /**
      * Add classifier to the artifact


Reply via email to