[Clirr-devel] CVS: clirr/xdocs anttask.xml,1.4,1.5 changes.xml,1.3,1.4

[Lars K?h. <lk...@us...>]

Update of /cvsroot/clirr/clirr/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27386

Modified Files:
	anttask.xml changes.xml 
Log Message:
documentation for formatter elements (RFE #958807)

Index: anttask.xml
===================================================================
RCS file: /cvsroot/clirr/clirr/xdocs/anttask.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- anttask.xml	20 May 2004 13:18:37 -0000	1.4
+++ anttask.xml	23 May 2004 08:58:37 -0000	1.5
@@ -124,6 +124,39 @@
         for details.
                 </p>
             </section>
+
+
+
+            <section name="formatter">
+
+                <p>
+        A formatter that generates Clirr output. Multiple formatters can be specified.
+        Available attributes for each formatter element:
+                </p>
+                <table>
+                    <tr>
+                        <td>Attribute</td>
+                        <td>Description</td>
+                        <td>Required</td>
+                        <td>Default</td>
+                    </tr>
+                    <tr>
+                        <td>type</td>
+                        <td>The formatter type. Available types are <em>plain</em> and <em>xml</em></td>
+                        <td>No</td>
+                        <td>plain</td>
+                    </tr>
+                    <tr>
+                        <td>outfile</td>
+                        <td>The file to write to. If not specified, output is written to stdout</td>
+                        <td>No</td>
+                        <td>stdout</td>
+                    </tr>
+                </table>
+            </section>
+            <p>
+                If no formatter is specified, Clirr will write it's findings to stdout in plain format.
+            </p>
         </section>
     </body>
 </document>

Index: changes.xml
===================================================================
RCS file: /cvsroot/clirr/clirr/xdocs/changes.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- changes.xml	23 May 2004 08:16:00 -0000	1.3
+++ changes.xml	23 May 2004 08:58:37 -0000	1.4
@@ -24,6 +24,10 @@
             create the impression that there are no compatibility problems,
             just because Clirr didn't report anything.
         </action>
+        <action dev="lkuehne" type="fix">
+            <!-- RFE #958807 -->
+            Documented formatter subelements in Ant task.
+        </action>
     </release>
 
     <release version="0.2" date="2004-05-22">