TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improved comments about output format

This commit is contained in:
oburn 2002-01-22 01:48:05 +00:00
parent d5c5f0c7d3
commit 1759f8135e
2 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/anttask.html
View File

@ -162,14 +162,34 @@ This task is included in the checkstyle distribution.</p>
<p>Older versions of the checkstyle task supported the boolean parameters <span class="default">relaxJavadoc</span> and <span class="default">ignoreJavadoc</span>. These parameters have been removed because they were conflicting and the semantics of <span class="default">relaxJavadoc</span> was not clearly specified. The two parameters have been replaced by the <span class="default">javadocScope</span> parameter. Instead of <span class="default">ignoreJavadoc="true"</span> you can now use <span class="default">javadocScope="nothing"</span>. The behaviour of <span class="default">relaxJavadoc="true"</span> is roughly the same as <span class="default">javadocScope="protected"</span>.</p>
<h3>Nested Elements</h3>
<p>Need to document that takes fileset and formatter elements. The arguments for formatter are:</p>
<ul>
<li>type - options are "plain" or "xml"</li>
<li>toFile - specifies the file to output to</li>
<li>classname - name of an AuditListener</li>
</ul>
<p>This task supports the nested elements <a href="http://jakarta.apache.org/ant/manual/CoreTypes/fileset.html">&lt;fileset&gt;</a> and <span class="default">&lt;formatter&gt;</span>. The parameters for the <span class="default">&lt;formatter&gt;</span> element are:</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr class="header">
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">type</td>
<td valign="top">
<p>The type of output to generate. The valid values are:</p>
<ul>
<li><span class="default">plain</span> - specifies the <a href="api/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a></li>
<li><span class="default">xml</span> - specifies the <a href="api/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a></li>
</ul>
<p>Defaults to <span class="default">"plain"</span>.</p>
</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">toFile</td>
<td valign="top">The file to write output to. Defaults to standard output. Note, there is no way to explicitly specify standard output.</p>
</td>
<td align="center" valign="top">No</td>
</tr>
</table>
<h3>Examples</h3>
@ -192,7 +212,7 @@ This task is included in the checkstyle distribution.</p>
&lt;/checkstyle&gt;
</pre>
<p><b>Run checkstyle on a set of files and output messages to standard out in plain format, and a file in XML format</b></p>
<p><b>Run checkstyle on a set of files and output messages to standard output in plain format, and a file in XML format</b></p>
<pre>
&lt;checkstyle&gt;
&lt;fileset dir=&quot;src/checkstyle&quot; includes=&quot;**/*.java&quot;/&gt;

4
docs/cmdline.html
View File

@ -35,8 +35,8 @@ This command line tool is included in the checkstyle distribution.</p>
<p>Checkstyle will process the specified files and by default report errors to standard out in plain format. The options are:</p>
<ul>
<li>-f format: specify the output format. Options are plain and xml. Defaults to "plain"</li>
<li>-o file: specify the file to output to.</li>
<li><span class="default">-f format</span> - specify the output format. Options are <span class="default">"plain"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/DefaultLogger.html">DefaultLogger</a> and <span class="default">"xml"</span> for the <a href="api/com/puppycrawl/tools/checkstyle/XMLLogger.html">XMLLogger</a>. Defaults to <span class="default">"plain"</span>.</li>
<li><span class="default">-o file</span> - specify the file to output to.</li>
</ul>
<p>The default behaviour of checkstyle can be changed by setting system properties using the <code>-D&lt;property&gt;=&lt;value&gt;</code> arguments to java. The following table describes what properties can be set:</p>