phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated some docs

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@1400 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland
2003-02-05 21:44:36 +00:00
parent 1d466f0ea0
commit 63b8e30b2f
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pmd/xdocs/howtowritearule.xml
View File

@ -11,8 +11,15 @@ Writing PMD rules is cool because you don't have to wait for us to get around to
</p> </p>
<subsection name="Get a development environment set up first"> <subsection name="Get a development environment set up first">
<p> <p>
In order to do rules, it'll help if you can modify the PMD source. <ul>
So download the latest PMD source release and unzip it somewhere on your computer. <li>In order to do rules, it'll help if you can modify the PMD source.
So download the latest PMD source release and unzip it somewhere on your computer.</li>
<li>You'll also need an Ant 1.5.1 jar file to compile against because PMD includes an
Ant task as part of the core distribution. You can get Ant binary
releases <a href="http://ant.apache.org/bindownload.cgi">here</a>.</li>
<li>PMD has a slew of JUnit tests, so you'll need a JUnit 3.8.1 binary release. You
can get that from <a href="http://www.junit.org/">here</a>.</li>
</ul>
</p> </p>
</subsection> </subsection>
<subsection name="Figure out what you want to look for"> <subsection name="Figure out what you want to look for">
@ -72,7 +79,7 @@ CompilationUnit
<p> <p>
You can generate this yourself by: You can generate this yourself by:
<ul> <ul>
<li>Run the batch file etc/astviewer.bat</li> <li>Run the batch file etc/astviewer.bat (note that you'll need a pmd.jar file in your CLASSPATH somewhere to use this utility)</li>
<li>Paste the code into the left pane and click the button at the bottom of the screen</li> <li>Paste the code into the left pane and click the button at the bottom of the screen</li>
</ul> </ul>
</p> </p>