svn commit: r1226017 - /maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java

[hb...@apache.org]

Author: hboutemy
Date: Sat Dec 31 01:43:42 2011
New Revision: 1226017

URL: http://svn.apache.org/viewvc?rev=1226017&view=rev
Log:
added explanations about this format, that is shared with a lot of tools

Modified:
    maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java

Modified: maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java
URL: http://svn.apache.org/viewvc/maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java?rev=1226017&r1=1226016&r2=1226017&view=diff
==============================================================================
--- maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java (original)
+++ maven/surefire/trunk/surefire-api/src/main/java/org/apache/maven/surefire/report/XMLReporter.java Sat Dec 31 01:43:42 2011
@@ -38,10 +38,15 @@ import org.codehaus.plexus.util.xml.Xpp3
 import org.codehaus.plexus.util.xml.Xpp3DomWriter;
 
 /**
- * XML format reporter.
+ * XML format reporter writing to <code>TEST-<i>reportName</i>[-<i>suffix</i>].xml</code> file like written and read
+ * by Ant's <a href="http://ant.apache.org/manual/Tasks/junit.html"><code>&lt;junit&gt;</code></a> and
+ * <a href="http://ant.apache.org/manual/Tasks/junitreport.html"><code>&lt;junitreport&gt;</code></a> tasks,
+ * then supported by many tools like CI servers.
  *
  * @author <a href="mailto:jruiz@exist.com">Johnny R. Ruiz III</a>
  * @version $Id$
+ * @see <a href="http://wiki.apache.org/ant/Proposals/EnhancedTestReports">Ant's format enhancement proposal</a>
+ * (not yet implemented by Ant 1.8.2)
  */
 public class XMLReporter
     extends AbstractReporter
@@ -58,7 +63,6 @@ public class XMLReporter
 
     private int elapsed = 0;
 
-
     public XMLReporter( boolean trimStackTrace, File reportsDirectory )
     {
         this( trimStackTrace, reportsDirectory, null );
@@ -81,7 +85,6 @@ public class XMLReporter
     {
     }
 
-
     public void testSetStarting( ReportEntry report )
         throws ReporterException
     {