Documentation in the Maven style. . .
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@22 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
David Dixon-Peugh
59
pmd/xdocs/ant-task.xml
Normal file
59
pmd/xdocs/ant-task.xml
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<document>
|
||||||
|
<properties>
|
||||||
|
<author email="tom@infoether.com">Tom Copeland</author>
|
||||||
|
<title>Ant Task</title>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="PMD">
|
||||||
|
<subsection name="Description">
|
||||||
|
Runs a set of PMD rules on a set of files and generates a report.
|
||||||
|
</subsection>
|
||||||
|
<subsection name="Parameters">
|
||||||
|
<table border="1" cellpadding="2" cellspacing="0">
|
||||||
|
<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 valign="top">reportfile</td>
|
||||||
|
<td valign="top">The file to which the report is written.</td>
|
||||||
|
<td valign="top" align="center">Yes</td>
|
||||||
|
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td valign="top">verbose</td>
|
||||||
|
<td valign="top">Verbose output - just the name of each file processed
|
||||||
|
Defaults to the current directory.</td>
|
||||||
|
<td valign="top" align="center">Yes</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
|
||||||
|
<td valign="top">rulesettype</td>
|
||||||
|
<td valign="top">The set of rules to use (all, general, cougaar)</td>
|
||||||
|
<td valign="top" align="center">Yes</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
</subsection>
|
||||||
|
<subsection name="Examples">
|
||||||
|
<source>
|
||||||
|
<![CDATA[
|
||||||
|
<target name="pmd">
|
||||||
|
<taskdef name="pmd" classname="com.infoether.pmd.PMDTask" />
|
||||||
|
<pmd reportFile="C:\foo.txt" verbose="false" rulesettype="general">
|
||||||
|
<fileset dir="C:\j2sdk1.4.0\src\">
|
||||||
|
<include name="**/*.java"/>
|
||||||
|
</fileset>
|
||||||
|
</pmd>
|
||||||
|
</target>
|
||||||
|
]]>
|
||||||
|
</source>
|
||||||
|
</subsection>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
19
pmd/xdocs/credits.xml
Normal file
19
pmd/xdocs/credits.xml
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<document>
|
||||||
|
<properties>
|
||||||
|
<author email="tom@infoether.org">Tom Copeland</author>
|
||||||
|
<title>Credits</title>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="Credits">
|
||||||
|
<ul>
|
||||||
|
<li>Thanks to <a href="http://www.sourceforge.net/">SourceForge</a> for hosting
|
||||||
|
<a href="http://www.sourceforge.net/projects/pmd/">this project</a></li>
|
||||||
|
<li>Thanks to <a href="http://www.webgain.com/">WebGain</a> for hosing
|
||||||
|
<a href="http://www.webgain.com/products/java_cc">JavaCC</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
18
pmd/xdocs/navigation.xml
Normal file
18
pmd/xdocs/navigation.xml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<project name="PMD">
|
||||||
|
<title>PMD</title>
|
||||||
|
<body>
|
||||||
|
<links>
|
||||||
|
<item name="SF Project Page"
|
||||||
|
href="http://www.sourceforge.net/projects/pmd" />
|
||||||
|
<item name="Hosted by SourceForge"
|
||||||
|
href="http://www.sourceforge.net" />
|
||||||
|
</links>
|
||||||
|
<menu name="Overview">
|
||||||
|
<item name="Ant Task" href="/ant-task.html" />
|
||||||
|
<item name="Credits" href="/credits.html" />
|
||||||
|
<item name="Similar Projects" href="/similar-projects.html" />
|
||||||
|
</menu>
|
||||||
|
</body>
|
||||||
|
</project>
|
||||||
33
pmd/xdocs/similar-projects.xml
Normal file
33
pmd/xdocs/similar-projects.xml
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<?xml version="1.0"?>
|
||||||
|
|
||||||
|
<document>
|
||||||
|
<properties>
|
||||||
|
<author email="tom@infoether.com">Tom Copeland</author>
|
||||||
|
<author email="ddp@apache.org">David Dixon-Peugh</author>
|
||||||
|
<title>Similar Projects</title>
|
||||||
|
</properties>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<section name="Similar Projects">
|
||||||
|
<subsection name="Commercial">
|
||||||
|
<ul>
|
||||||
|
<li><a href="http://www.parasoft.com">JTest</a>- Very nice with tons of features,
|
||||||
|
but also very expensive and requires a running X server (or Xvfb) to run on
|
||||||
|
Linux. They charge $500 to move a license from one machine to another.</li>
|
||||||
|
</ul>
|
||||||
|
</subsection>
|
||||||
|
<subsection name="Open Source">
|
||||||
|
<ul>
|
||||||
|
<li><a href="http://doctorj.org">DoctorJ</a>- Written in C++, checks Javadoc, syntax
|
||||||
|
and calculates metrics.</li>
|
||||||
|
<li><a href="http://www.artho.com/jlint/download.shtml">JLint</a>- Written in C++,
|
||||||
|
does lots of synchronization checks.</li>
|
||||||
|
<li><a href="http://www.tbbr32568.pwb.blueyonder.co.uk/jnp/">JNP</a>- Nifty research
|
||||||
|
projects, uses JJTree/JavaCC.</li>
|
||||||
|
<li><a href="http://checkstyle.sourceforge.net/">Checkstyle</a>- Very detailed,
|
||||||
|
supports both Maven and Ant.</li>
|
||||||
|
</ul>
|
||||||
|
</subsection>
|
||||||
|
</section>
|
||||||
|
</body>
|
||||||
|
</document>
|
||||||
Reference in New Issue
Block a user