diff --git a/pmd/xdocs/ant-task.xml b/pmd/xdocs/ant-task.xml index 64e9156134..e73b080269 100644 --- a/pmd/xdocs/ant-task.xml +++ b/pmd/xdocs/ant-task.xml @@ -19,11 +19,6 @@ Description Required - - formatter - Specifies the format of and the files to which the report is written. Formats can be of type 'xml', 'text', 'csv', 'papari', 'summaryhtml', or 'html', filenames can be either relative or absolute, and you can supply a "linkPrefix" for linking to online HTMLized source (like this). See example belows. - Yes - rulesetfiles A comma delimited list of ruleset files ('rulesets/basic.xml,rulesets/design.xml'). If you write @@ -40,11 +35,6 @@ Whether or not to fail the build if PMD finds any problems No - - A nested classpath element - Also accepts a nested classpath element so you can specify custom ruleset files more easily. See the example below. - No - printToConsole Whether or not to print any problems found to the Ant log/console @@ -77,7 +67,46 @@ - +

formatter nested element - specifies the format of and the files to which the report is written.

+ + + + + + + + + + + + + + +
NameValues
formatxml,html,text,csv,papari,summaryhtml
filenameA filename to which to write the report
linkPrefixUsed for linking to online HTMLized source (like this). See example below.
+ +

classpath nested element - useful for specifying custom rule. More details on the classpath + element are in the Ant documentation here and there's + an example below.

+ +

ruleset nested element - another way to specify rulesets. Here's an example:

+ + + + + rulesets/favorites.xml + basic + + + + + + +]]> + + + +

Several folks (most recently, Wouter Zelle) have written XSLT scripts @@ -212,30 +241,13 @@ Total time: 2 seconds - - - - - - - - -]]> - - -

Using the ruleset nested element

- - - - - rulesets/favorites.xml - basic - - - - - + + + + + + + ]]>