[jboss-svn-commits] JBL Code SVN: r35728 - labs/jbosslabs/labs-3.0-build/integration/sbs/reports/trunk/src/main/java/org/jboss/community/sbs/plugin/reports/monthly/config.

[jboss-svn-commits at lists.jboss.org]

Author: velias
Date: 2010-10-26 03:37:52 -0400 (Tue, 26 Oct 2010)
New Revision: 35728

Modified:
   labs/jbosslabs/labs-3.0-build/integration/sbs/reports/trunk/src/main/java/org/jboss/community/sbs/plugin/reports/monthly/config/ReportConfigParser.java
Log:
Added notes for configuration file format into javadoc

Modified: labs/jbosslabs/labs-3.0-build/integration/sbs/reports/trunk/src/main/java/org/jboss/community/sbs/plugin/reports/monthly/config/ReportConfigParser.java
===================================================================
--- labs/jbosslabs/labs-3.0-build/integration/sbs/reports/trunk/src/main/java/org/jboss/community/sbs/plugin/reports/monthly/config/ReportConfigParser.java	2010-10-26 00:29:16 UTC (rev 35727)
+++ labs/jbosslabs/labs-3.0-build/integration/sbs/reports/trunk/src/main/java/org/jboss/community/sbs/plugin/reports/monthly/config/ReportConfigParser.java	2010-10-26 07:37:52 UTC (rev 35728)
@@ -36,6 +36,18 @@
  * </projects>
  * </pre>
  * 
+ * Some notes for configuration file format:
+ * <ul>
+ * <li><code>project</code> elements may be multiplied.
+ * <li><code>project at name</code> attribute is mandatory (can't be empty).
+ * <li><code>jira</code>, <code>sbs</code>, <code>sbs/user</code>, <code>sbs/dev</code> and <code>fisheye</code>
+ * elements may be empty.
+ * <li><code>project-key</code> and <code>space</code> elements may be empty.
+ * <li><code>project-key</code>, <code>space</code> and <code>repo</code> elements may be multiplied.
+ * <li><code>repo at name</code> attribute is mandatory (can't be empty). So remove whole <code>repo</code> element.
+ * <li><code>repo at path</code> attribute is optional (can be empty or not present).
+ * </ul>
+ * 
  * @author Vlastimil Elias (velias at redhat dot com)
  */
 public class ReportConfigParser {