Author: dennisl
Date: Tue Jan 22 15:07:46 2008
New Revision: 614369
URL: http://svn.apache.org/viewvc?rev=614369&view=rev
Log:
o Set suitable default values for statusIds and resolutionIds.
o Improve documentation.
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JiraMojo.java
Modified:
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JiraMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JiraMojo.java?rev=614369&r1=614368&r2=614369&view=diff
==============================================================================
---
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JiraMojo.java
(original)
+++
maven/plugins/trunk/maven-changes-plugin/src/main/java/org/apache/maven/plugin/jira/JiraMojo.java
Tue Jan 22 15:07:46 2008
@@ -85,7 +85,7 @@
private Settings settings;
/**
- * Maximum number of entries to be displayed by the JIRA Report.
+ * Maximum number of entries to be fetched from JIRA.
*
* @parameter default-value=100
*
@@ -94,7 +94,7 @@
/**
* Defines the filter parameters to restrict which issues are retrieved
- * from JIRA. The filter parameter must use the same format of url
+ * from JIRA. The filter parameter uses the same format of url
* parameters that is used in a JIRA search.
*
* @parameter default-value=""
@@ -113,27 +113,40 @@
private String fixVersionIds;
/**
- * Sets the status(es) that you want to limit your report to include.
- * Valid statuses are: Open, In Progress, Reopened, Resolved and Closed.
+ * Sets the status(es) that you want to fetch from JIRA.
+ * Valid statuses are: <code>Open</code>, <code>In Progress</code>,
+ * <code>Reopened</code>, <code>Resolved</code> and <code>Closed</code>.
* Multiple values can be separated by commas.
+ * <p>
+ * <b>Note:</b> In versions 2.0-beta-3 and earlier this parameter had no
+ * default value.
+ * </p>
*
- * @parameter default-value=""
+ * @parameter default-value="Closed"
*/
private String statusIds;
/**
- * Sets the resolution(s) that you want to limit your report to include.
- * Valid statuses are: Unresolved, Fixed, Won't Fix, Duplicate, Incomplete,
- * Cannot Reproduce. Multiple values can be separated by commas.
+ * Sets the resolution(s) that you want to fetch from JIRA.
+ * Valid resolutions are: <code>Unresolved</code>, <code>Fixed</code>,
+ * <code>Won't Fix</code>, <code>Duplicate</code>, <code>Incomplete</code>
+ * and <code>Cannot Reproduce</code>.
+ * Multiple values can be separated by commas.
+ * <p>
+ * <b>Note:</b> In versions 2.0-beta-3 and earlier this parameter had no
+ * default value.
+ * </p>
*
- * @parameter default-value=""
+ * @parameter default-value="Fixed"
*/
private String resolutionIds;
/**
* Sets the priority(s) that you want to limit your report to include.
- * Valid statuses are: Blocker, Critical, Major, Minor, Trivial. Multiple
- * values can be separated by commas.
+ * Valid statuses are <code>Blocker</code>, <code>Critical</code>,
+ * <code>Major</code>, <code>Minor</code> and <code>Trivial</code>.
+ * Multiple values can be separated by commas.
+ * If this is set to empty - that means all priorities will be included.
*
* @parameter default-value=""
*/
@@ -141,8 +154,8 @@
/**
* Sets the component(s) that you want to limit your report to include.
- * Multiple components can be separated by commas (such as 10011,10012).
- * If this is set to empty - that means all components.
+ * Multiple values can be separated by commas (such as 10011,10012).
+ * If this is set to empty - that means all components will be included.
*
* @parameter default-value=""
*/
@@ -152,8 +165,9 @@
* Sets the types(s) that you want to limit your report to include.
* Valid types are: <code>Bug</code>, <code>New Feature</code>,
* <code>Task</code>, <code>Improvement</code>, <code>Wish</code>,
- * <code>Test</code> and <code>Sub-task</code>. Multiple
- * values can be separated by commas.
+ * <code>Test</code> and <code>Sub-task</code>.
+ * Multiple values can be separated by commas.
+ * If this is set to empty - that means all types will be included.
*
* @parameter default-value=""
* @since 2.0-beta-4
