svn commit: r422073 - in /maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven: announcement/AnnouncementMailMojo.java announcement/AnnouncementMojo.java changes/ChangesMojo.java jira/JiraMojo.java

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r422073 - in /maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven: announcement/AnnouncementMailMojo.java announcement/AnnouncementMojo.java changes/ChangesMojo.java jira/JiraMojo.java

Dennis Lundberg-2
Author: dennisl
Date: Fri Jul 14 14:57:36 2006
New Revision: 422073

URL: http://svn.apache.org/viewvc?rev=422073&view=rev
Log:
Move class @description annotations to class Javadocs
Improve parameter documentation

Modified:
    maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMailMojo.java
    maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMojo.java
    maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/changes/ChangesMojo.java
    maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/jira/JiraMojo.java

Modified: maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMailMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMailMojo.java?rev=422073&r1=422072&r2=422073&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMailMojo.java (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMailMojo.java Fri Jul 14 14:57:36 2006
@@ -1,8 +1,7 @@
-
 package org.apache.maven.announcement;
 
 /*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,16 +31,14 @@
 import java.io.IOException;
 import java.util.List;
 
-
-
 /**
- * Maven Announcement mailer goal.
+ * Goal which sends an announcement through email.
+ *
  * @goal announcement-mail
  * @execute goal="announcement-generate"
- * @description Goal which sends the template thru email
  * @author [hidden email]
+ * @version $Id$
  */
-
 public class AnnouncementMailMojo extends AbstractMojo
 {
     //=========================================
@@ -55,14 +52,16 @@
     private MavenProject project;
     
     /**
-     * Smtp Server
+     * Smtp Server.
+     *
      * @parameter
      * @required
      */
     private String smtpHost;
     
     /**
-     * Port
+     * Port.
+     *
      * @parameter default-value="25";
      * @required
      */
@@ -84,7 +83,8 @@
     private boolean sslMode;
     
     /**
-     * Subject for the email
+     * Subject for the email.
+     *
      * @parameter default-value="[ANNOUNCEMENT] - ${project.artifactId} ${project.version} release!"
      * @required
      */
@@ -92,13 +92,15 @@
     
     /**
      * Recipient email address.
+     *
      * @parameter
      * @required
      */
     private List toAddresses;
     
     /**
-     * Sender
+     * Sender.
+     *
      * @parameter expression="${project.developers}"
      * @required
      */
@@ -106,12 +108,15 @@
     
     /**
      * Directory which contains the template for announcement email.
+     *
      * @parameter expression="${project.build.directory}/announcement"
      * @required
      */
     private String templateOutputDirectory;
     
     /**
+     * The Velocity template used to format the announcement.
+     *
      * @parameter default-value="announcement.vm"
      * @required
      */
@@ -176,7 +181,6 @@
     /**
      * Send the email
      *
-     * @param recipient receiver of the email
      * @throws MojoExecutionException
      */
     protected void sendMessage() throws MojoExecutionException

Modified: maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMojo.java?rev=422073&r1=422072&r2=422073&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMojo.java (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/announcement/AnnouncementMojo.java Fri Jul 14 14:57:36 2006
@@ -1,7 +1,7 @@
 package org.apache.maven.announcement;
 
 /*
- * Copyright 2001-2005 The Apache Software Foundation.
+ * Copyright 2001-2006 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,17 +35,18 @@
 import java.util.List;
 
 /**
+ * Goal which generate the template for an announcement.
+ *
  * @goal announcement-generate
- * @description Goal which generate the template for announcement
+ * @requiresDependencyResolution test
  * @author [hidden email]
  * @version $Id$
- *
- * @requiresDependencyResolution test
  */
 public class AnnouncementMojo extends AbstractMojo
 {            
     /**
-     * Directory where the template file will be generated
+     * Directory where the template file will be generated.
+     *
      * @parameter expression="${project.build.directory}/announcement"
      * @required
      */
@@ -64,74 +65,86 @@
     private String artifactId;
     
     /**
-     * Version of the plugin
+     * Version of the artifact.
+     *
      * @parameter expression="${project.version}"
      * @readonly
      */
     private String version;
     
     /**
-     * Distribution url of the plugin
+     * Distribution url of the artifact.
+     *
      * @parameter expression="${project.url}"
      * @required
      */
     private String url;
     
     /**
-     * Packaging structure based on the pom
+     * Packaging structure for the artifact.
+     *
      * @parameter expression="${project.packaging}"
      * @readonly
      */
     private String packaging;
     
     /**
+     * The name of the artifact to be used in the announcement.
+     *
      * @parameter expression="${project.build.finalName}.${project.packaging}"
      * @required
      */
     private String finalName;
     
     /**
-     * URL where the plugin can be downloaded
+     * URL where the artifact can be downloaded.
+     *
      * @parameter expression="${project.url}/${project.build.finalName}.jar"
      */
     private String urlDownload;
     
     /**
-     * Directory which contains the changes.xml file
+     * The path of the changes.xml file.
+     *
      * @parameter expression="${basedir}/src/changes/changes.xml"
      * @required
      */
     private String xmlPath;
     
     /**
-     * Name of the team that develops the project
+     * Name of the team that develops the artifact.
+     *
      * @parameter default-value="${project.artifactId}-team"
      * @required
      */
     private String developmentTeam;
     
     /**
-     * Short description or introduction of the released project.
+     * Short description or introduction of the released artifact.
+     *
      * @parameter expression="${project.description}"
      */
     private String introduction;
     
     /**
-     * Velocity Component
+     * Velocity Component.
+     *
      * @parameter expression="${component.org.codehaus.plexus.velocity.VelocityComponent}"
      * @readonly
      */
     private VelocityComponent velocity;
     
     /**
-     * Name of the tempalte to be generated
+     * The Velocity template used to format the announcement.
+     *
      * @parameter default-value="announcement.vm"
      * @required
      */
     private String template;
     
     /**
-     * Directory that contains the template
+     * Directory that contains the template.
+     *
      * @parameter default-value="org/apache/maven/announcement"
      * @required
      */
@@ -145,6 +158,7 @@
     
     /**
      * The Maven Project.
+     *
      * @parameter expression="${project}"
      * @required
      * @readonly
@@ -160,7 +174,8 @@
     private Settings setting;
     
     /**
-     * Flag to determine that the plugin will generate a jira announcement
+     * Flag to determine if the plugin will generate a JIRA announcement.
+     *
      * @parameter expression="${generateJiraAnnouncement}" default-value="false"
      * @required
      */
@@ -168,18 +183,21 @@
     
     /**
      * Only closed issues are needed.
+     *
      * @parameter default-value="Closed"
      */
     private String statusId;
     
     /**
-     * Only fixed issues are needed
+     * Only fixed issues are needed.
+     *
      * @parameter default-value="Fixed"
      */
     private String resolutionId;
     
     /**
-     * Directory containing the XML file of jira-announcement to be parse
+     * The path of the XML file of Jira-announcements to be parsed.
+     *
      * @parameter expression="${project.build.directory}/jira-announcement.xml"
      * @required
      * @readonly
@@ -187,6 +205,8 @@
     private String jiraXML;
     
     /**
+     * The maximum number of issues to include.
+     *
      * @parameter default-value="25"
      * @required
      */

Modified: maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/changes/ChangesMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/changes/ChangesMojo.java?rev=422073&r1=422072&r2=422073&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/changes/ChangesMojo.java (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/changes/ChangesMojo.java Fri Jul 14 14:57:36 2006
@@ -1,7 +1,7 @@
 package org.apache.maven.changes;
 
 /*
- * Copyright 2001-2005 The Codehaus.
+ * Copyright 2001-2006 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,8 +26,9 @@
 import org.codehaus.doxia.site.renderer.SiteRenderer;
 
 /**
+ * Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.
+ *
  * @goal changes-report
- * @description Goal wich creates a nicely formatted Changes Report in html format from changes.xml.
  * @author <a href="mailto:[hidden email]">Johnny R. Ruiz III</a>
  * @version $Id$
  */
@@ -36,6 +37,7 @@
 {
     /**
      * Directory where reports will go.
+     *
      * @parameter expression="${project.build.directory}/site "
      * @required
      * @readonly
@@ -57,17 +59,19 @@
     private MavenProject project;
 
     /**
-     * The changes.xml that will be converted into an html report.
+     * The path of the changes.xml file that will be converted into an html report.
+     *
      * @parameter expression="${basedir}/src/changes/changes.xml"
      * @required
      */
     private String xmlPath;
 
     /**
-     * Template string that is used to discover the URL to use to display a bug report.
+     * Template string that is used to discover the URL to use to display an issue report.
      * There are 2 template tokens you can use. %URL%: this is computed by getting the
      * &lt;issueManagement&gt;&lt;url&gt; value from the POM, and removing the context path. %ISSUE% :
      * this is the issue number.
+     *
      * @parameter expression="%URL%/ViewIssue.jspa?key=%ISSUE%"
      *
      */

Modified: maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/jira/JiraMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/jira/JiraMojo.java?rev=422073&r1=422072&r2=422073&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/jira/JiraMojo.java (original)
+++ maven/sandbox/plugins/maven-changes-plugin/src/main/java/org/apache/maven/jira/JiraMojo.java Fri Jul 14 14:57:36 2006
@@ -1,7 +1,7 @@
 package org.apache.maven.jira;
 
 /*
- * Copyright 2001-2005 The Codehaus.
+ * Copyright 2001-2006 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,9 +28,9 @@
 import java.util.ResourceBundle;
 
 /**
- * Report on issues from the Issue Tracking System
+ * Goal which downloads issues from the Issue Tracking System and generates a report.
+ *
  * @goal jira-report
- * @description Goal wich downloads issues from Issue Tracking System and generates a report.
  * @author <a href="mailto:[hidden email]">Johnny R. Ruiz III</a>
  * @version $Id$
  */
@@ -47,7 +47,7 @@
     private String outputDirectory;
 
     /**
-     * Path of the Jira XML to be parsed.
+     * Path of the Jira XML file to be parsed.
      *
      * @parameter expression="${project.build.directory}/jira-results.xml "
      * @required
@@ -92,7 +92,8 @@
 
     /**
      * Defines the filter parameters to restrict the result issues from Jira.
-     * The filter parameters property must use the same format of url parameters from the Jira search
+     * The filter parameters property must use the same format of url parameters from the Jira search.
+     *
      * @parameter default-value=""
      */
     private String filter;
@@ -100,6 +101,7 @@
     /**
      * Sets the status(es) of the project you want to limit your report to.
      * Valid statuses are: Open, In Progress, Reopened, Resolved and Closed. Multiple values can be separated by commas.
+     *
      * @parameter default-value=""
      */
     private String statusIds;
@@ -107,7 +109,8 @@
     /**
      * Sets the resolution(s) of the project you want to limit your report to.
      * Valid statuses are: Unresolved, Fixed, Won't Fix, Duplicate, Incomplete, Cannot Reproduce.
-     * Multiple values can be separated by comma.
+     * Multiple values can be separated by commas.
+     *
      * @parameter default-value=""
      */
     private String resolutionIds;
@@ -115,6 +118,7 @@
     /**
      * Sets the priority(s) of the project you want to limit your report to.
      * Valid statuses are: Blocker, Critical, Major, Minor, Trivial. Multiple values can be separated by commas.
+     *
      * @parameter default-value=""
      */
     private String priorityIds;
@@ -123,30 +127,35 @@
      * Sets the component(s) of the project you want to limit your report to.
      * Multiple components can be separated by commas (such as 10011,10012).
      * Default-value -  empty, meaning all components.
+     *
      * @parameter default-value=""
      */
     private String component;
 
     /**
-     * Defines the jira username for authentication into a private Jira instalation.
+     * Defines the Jira username for authentication into a private Jira installation.
+     *
      * @parameter default-value=""
      */
     private String jiraUser;
 
     /**
-     * Defines the jira password for authentication into a private Jira instalation.
+     * Defines the Jira password for authentication into a private Jira installation.
+     *
      * @parameter default-value=""
      */
     private String jiraPassword;
 
     /**
      * Defines the http user for basic authentication into the Jira webserver.
+     *
      * @parameter default-value=""
      */
     private String webUser;
 
     /**
      * Defines the http password for basic authentication into the Jira webserver.
+     *
      * @parameter default-value=""
      */
     private String webPassword;