diff --git a/pmd/xdocs/ant-task.xml b/pmd/xdocs/ant-task.xml index 4a8ff013e8..eed4627764 100644 --- a/pmd/xdocs/ant-task.xml +++ b/pmd/xdocs/ant-task.xml @@ -10,7 +10,7 @@
-

Runs a set of static code analysis rules on Java source code files and generates a list of problems found.

+

Runs a set of static code analysis rules on some Java source code files and generates a list of problems found.

@@ -20,17 +20,27 @@ - - + + + + + + + + + + + + @@ -41,68 +51,15 @@ - - - - - - - - - -
Required
formatterSpecifies formats and files to which the report is written. Can be of type 'xml' or 'html'. See example below.reportfileThe file to which the report is written. Yes
verboseVerbose output - names of files processed, rule counts, etc.No
rulesetfiles A comma delimited list of ruleset files ('rulesets/basic.xml,rulesets/design.xml'). If you write your own ruleset files, you can put them on the classpath and plug them in here. Yes
formatThe report format (xml, html)Yes
failonerror Whether or not to fail the build if PMD finds any problemsWhether or not to print any problems found to the Ant log/console No
shortFilenamesPlaces truncated filenames in the report. This can reduce your report file size by 15%-20%.No
verboseVerbose output - names of files processed, rule counts, etc.No
- -

-PMD can record its information into a JDBC datasource using a ]]> tag. This -tag has several attributes: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AttributeDescriptionRequired
driverClass name of the JDBC driver to use to connect to the database.Optional. If your default system is set up to install the JDBC driver, - or if something else will install it, don't do it. Otherwise, provide the - value.
urlJDBC URL to connect to the database with.Required
userUser to connect to the database as.Required
passwordPassword to use for logging into the database.Required
projectidThis is an integer which will get put into the PMD_RUNS table. Ideally this should - be used to connect this run to other data in the system.Optional. If this value is ommitted, the default value will be 0.
-

-
- - - + @@ -111,20 +68,7 @@ tag has several attributes: - - - - - - - - - - - - - +