Title: [1462] trunk/core/distribution/src/site/content: JBEHAVE-227: Updated documentation.
Revision
1462
Author
mauro
Date
2009-12-23 12:06:31 -0600 (Wed, 23 Dec 2009)

Log Message

JBEHAVE-227:  Updated documentation.
Set default Ant and Maven report rendering formats to empty list, as this depends on the reports configured.

Modified Paths

Diff

Modified: trunk/core/distribution/src/site/content/reports.html (1461 => 1462)

--- trunk/core/distribution/src/site/content/reports.html	2009-12-23 17:57:34 UTC (rev 1461)
+++ trunk/core/distribution/src/site/content/reports.html	2009-12-23 18:06:31 UTC (rev 1462)
@@ -25,6 +25,10 @@
     specialises the <b>PrintStreamScenarioReporter</b> to use HTML
     formats</li>
     <li><a
+        href=""
+    specialises the <b>PrintStreamScenarioReporter</b> to use XML
+    formats</li>
+    <li><a
         href=""
     collects statistics and stores them as properties</li>
     <li><a
@@ -49,7 +53,6 @@
         
             @Override
             public ScenarioReporter forReportingScenarios() {
-                return new DelegatingScenarioReporter (
                 return new DelegatingScenarioReporter(
                         // report to System.out
                         new PrintStreamScenarioReporter(),
@@ -59,6 +62,9 @@
                         // report to .html file in HTML format
                         new HtmlPrintStreamScenarioReporter(new FilePrintStreamFactory(scenarioClass, converter,
                                 new FileConfiguration("html")).getPrintStream()),
+                        // report to .xml file in XML format
+                        new XmlPrintStreamScenarioReporter(new FilePrintStreamFactory(scenarioClass, converter,
+                                new FileConfiguration("xml")).getPrintStream()),
                         // report to .stats file in Properties format
                         new StatisticsScenarioReporter(new FilePrintStreamFactory(scenarioClass, converter,
                                 new FileConfiguration("stats")).getPrintStream()));
@@ -76,8 +82,7 @@
 name resolution mechanism used for mapping Java classes and textual
 scenarios. So, e.g., if the scenario class is <b>com.example.MyScenario</b>,
 we'll end up with file report outputs of the form: <b>com.example.my_scenario.[format]</b>
-(where <b>format</b> is <b>txt</b>, <b>html</b> and <b>stats</b>in the
-example above).</p>
+(where <b>format</b> is any of <b>txt,html,xml,stats</b>in the example above).</p>
 
 <h2>Report Rendering</h2>
 

Modified: trunk/core/distribution/src/site/content/running-scenarios.html (1461 => 1462)

--- trunk/core/distribution/src/site/content/running-scenarios.html	2009-12-23 17:57:34 UTC (rev 1461)
+++ trunk/core/distribution/src/site/content/running-scenarios.html	2009-12-23 18:06:31 UTC (rev 1462)
@@ -39,7 +39,7 @@
     classpathref="your.runtime.classpath" />
   
   <renderReports outputDirectory="${basedir}/target/jbehave-reports"
-    formats="html,txt,stats" />
+    formats="txt,html,xml,stats" />
     
 </pre>
 
@@ -88,6 +88,7 @@
               <formats>
                 <format>txt</format>
                 <format>html</format>
+                <format>xml</format>
                 <format>stats</format>
               </formats>
             </configuration>

Modified: trunk/core/jbehave-ant/src/main/java/org/jbehave/ant/ReportRendererTask.java (1461 => 1462)

--- trunk/core/jbehave-ant/src/main/java/org/jbehave/ant/ReportRendererTask.java	2009-12-23 17:57:34 UTC (rev 1461)
+++ trunk/core/jbehave-ant/src/main/java/org/jbehave/ant/ReportRendererTask.java	2009-12-23 18:06:31 UTC (rev 1462)
@@ -27,7 +27,7 @@
     /**
      * The format of the generated output
      */
-    private List<String> formats = asList("html", "xml", "txt");
+    private List<String> formats = asList();
 
     public void execute() throws BuildException {
         ReportRenderer renderer = new FreemarkerReportRenderer();

Modified: trunk/core/jbehave-maven-plugin/src/main/java/org/jbehave/mojo/ReportRendererMojo.java (1461 => 1462)

--- trunk/core/jbehave-maven-plugin/src/main/java/org/jbehave/mojo/ReportRendererMojo.java	2009-12-23 17:57:34 UTC (rev 1461)
+++ trunk/core/jbehave-maven-plugin/src/main/java/org/jbehave/mojo/ReportRendererMojo.java	2009-12-23 18:06:31 UTC (rev 1462)
@@ -32,11 +32,11 @@
     private File outputDirectory;
 
     /**
-     * Formats of generated output. Defaults to asList("html", "xml", "txt").
+     * Formats of generated output. Defaults to asList().
      * 
      * @parameter 
      */
-    private List<String> formats = asList("html", "xml", "txt");
+    private List<String> formats = asList();
 
     /**
      * <i>Maven Internal</i>: The Doxia Site Renderer.


To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to