From 1759f8135e628adc00b0ab4bbebb98fee531d06d Mon Sep 17 00:00:00 2001 From: oburn Date: Tue, 22 Jan 2002 01:48:05 +0000 Subject: [PATCH] improved comments about output format --- docs/anttask.html | 34 +++++++++++++++++++++++++++------- docs/cmdline.html | 4 ++-- 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/docs/anttask.html b/docs/anttask.html index 428735732..df2052a29 100644 --- a/docs/anttask.html +++ b/docs/anttask.html @@ -162,14 +162,34 @@ This task is included in the checkstyle distribution.

Older versions of the checkstyle task supported the boolean parameters relaxJavadoc and ignoreJavadoc. These parameters have been removed because they were conflicting and the semantics of relaxJavadoc was not clearly specified. The two parameters have been replaced by the javadocScope parameter. Instead of ignoreJavadoc="true" you can now use javadocScope="nothing". The behaviour of relaxJavadoc="true" is roughly the same as javadocScope="protected".

Nested Elements

-

Need to document that takes fileset and formatter elements. The arguments for formatter are:

- +

This task supports the nested elements <fileset> and <formatter>. The parameters for the <formatter> element are:

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
type +

The type of output to generate. The valid values are:

+ +

Defaults to "plain".

+ 		No
toFileThe file to write output to. Defaults to standard output. Note, there is no way to explicitly specify standard output.

+ 		No

Examples

@@ -192,7 +212,7 @@ This task is included in the checkstyle distribution.

</checkstyle> -

Run checkstyle on a set of files and output messages to standard out in plain format, and a file in XML format

+

Run checkstyle on a set of files and output messages to standard output in plain format, and a file in XML format

   <checkstyle>
     <fileset dir="src/checkstyle" includes="**/*.java"/>
diff --git a/docs/cmdline.html b/docs/cmdline.html
index 8780ddcec..f46cf637a 100644
--- a/docs/cmdline.html
+++ b/docs/cmdline.html
@@ -35,8 +35,8 @@ This command line tool is included in the checkstyle distribution.

 
Checkstyle will process the specified files and by default report errors to standard out in plain format. The options are:

 
 
 
 
The default behaviour of checkstyle can be changed by setting system properties using the -D<property>=<value> arguments to java. The following table describes what properties can be set: