hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Added documentation for database tag.

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@1297 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
David Dixon-Peugh
2002-12-15 02:12:08 +00:00
parent e5e6c9ec56
commit 9d8b1921f9
1 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
pmd/xdocs/ant-task.xml
View File

@ -49,6 +49,48 @@
</table>
</subsection>
<subsection name="Database">
<p>
PMD can record its information into a JDBC datasource using a <![CDATA[<database />]]> tag. This
tag has several attributes:
<table>
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td>driver</td>
<td>Class name of the JDBC driver to use to connect to the database.</td>
<td><i>Optional.</i> 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.</td>
</tr>
<tr>
<td>url</td>
<td>JDBC URL to connect to the database with.</td>
<td>Required</td>
</tr>
<tr>
<td>user</td>
<td>User to connect to the database as.</td>
<td>Required</td>
</tr>
<tr>
<td>password</td>
<td>Password to use for logging into the database.</td>
<td>Required</td>
</tr>
<tr>
<td>projectid</td>
<td>This 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.</td>
<td><i>Optional.</i> If this value is ommitted, the default value will be 0.</td>
</tr>
</table>
</p>
</subsection>
<subsection name="Examples">
<source>
<![CDATA[
@ -71,6 +113,18 @@
</fileset>
</pmd>
</target>
<target name="pmd">
<taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask" />
<pmd verbose="true" rulesetfiles="rulesets/basic.xml,rulesets/design.xml" failonerror="no">
<database driver="com.mysql.jdbc.Driver" url="jdbc:mysql:///pmd" user="david"
password="" projectid="10" />
<formatter type="xml" toFile="c:\jdk-report.xml"/>
<fileset dir="C:\j2sdk1.4.0\src\">
<include name="**/*.java"/>
</fileset>
</pmd>
</target>
]]>
</source>
</subsection>