Fixed typo, added docs for Wouter's new XSLT

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@3631 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland
2005-06-29 15:03:23 +00:00
parent 7d2bbd0142
commit 62a1ae0312
4 changed files with 22 additions and 2 deletions

View File

@ -2,6 +2,7 @@
Implemented RFE 1220171 - rule definitions can now contain a link to an external URL for more information on that rule - for example, a link to the rule's web page. Thanks to Wouter Zelle for designing and implementing this!
Fixed bug 1226858 - JUnitAssertionsShouldIncludeMessage now checks calls to assertFalse.
Fixed bug 1227001 - AvoidCallingFinalize no longer flags calls to finalize() within finalizers.
Fixed bug 1229755 - Fixed typo in ArrayIsStoredDirectly description.
Fixed a bug in RuleSetFactory that missed some override cases; thx to Wouter Zelle for the report and a fix.
Added some new XSLT scripts that create nifty HTML output; thanks to Wouter Zelle for the code.
Improved UseCorrectExceptionLogging; thx to Wouter Zelle for the new XPath.

View File

@ -32,7 +32,7 @@ These rules check the security guidelines from Sun, published at http://java.sun
message="A user given array is stored directly"
class="net.sourceforge.pmd.rules.sunsecure.ArrayIsStoredDirectly">
<description>
Constructors and methods receiving arrays shuold clone objects and store the copy.
Constructors and methods receiving arrays should clone objects and store the copy.
This prevents that future changes from the user affect the internal functionallity.
</description>
<priority>3</priority>

View File

@ -78,6 +78,25 @@
</table>
</subsection>
<subsection name="Postprocessing the report file with XSLT">
<p>Several folks (most recently, Wouter Zelle) have written XSLT scripts
which you can use to transform the XML report into nifty HTML. To do this,
make sure you use the XML formatter in the PMD task invocation, i.e.:
</p>
<source>
<![CDATA[
<formatter type="xml" toFile="${tempbuild}/$report_pmd.xml"/>
]]>
</source>
<p>Then, after the end of the PMD task, do this:</p>
<source>
<![CDATA[
<xslt in="${tempbuild}/$report_pmd.xml" style="${pmdConfig}/wz-pmd-report.xslt" out="${pmdOutput}/$report_pmd.html" />
]]>
</source>
</subsection>
<subsection name="Examples">
<p>Running one ruleset to produce a HTML report</p>

View File

@ -43,6 +43,7 @@
</subsection>
<subsection name="Contributors">
<ul>
<li>Pieter Bloemendaal - Found typo in ArrayIsStoredDirectly, bug report for AvoidReassigningParametersRule</li>
<li>Wouter Zelle - Some very nifty XSLT, improvements to UseCorrectExceptionLogging, designed and implemented the "externalInfoUrl" feature in the rule definitions, fixed a devious bug in RuleSetFactory, AvoidPrintStackTrace, initial implementation of SimplifyConditional</li>
<li>Jorn Stampehl - Noticed redundancy of ExplicitCallToFinalize, reported bug in AvoidCallingFinalize, reported bug in JUnitAssertionsShouldIncludeMessage</li>
<li>Wim Deblauwe - front page and "how to make a ruleset" patches, noted problems with web site rule index, bug report for JUnitTestsShouldContainAsserts, Clover license coordination and implementation, UseCorrectExceptionLogging, coordinated and coded a much nicer asXML() implementation, suggested cleanup of UnusedFormalParameter, Javadoc patch, SystemPrintln bug report, helped get Ant task and CLI squared away with JDK 1.5 params, JDK 1.5-specific bug reports, suggested improvements for ExceptionSignatureDeclaration</li>
@ -127,7 +128,6 @@
<li>Slava Pestov - Suggestions for jEdit plugin enhancements.</li>
<li>Olivier Mengué - Diagnosed and patched XML report character encoding problems</li>
<li>Hariolf Häfele - PMD-JDeveloper plugin bug reports</li>
<li>Pieter Bloemendaal - AvoidReassigningParametersRule bug report</li>
<li>Vladimir Bossicard - suggested AbstractNamingRule, test package organization suggestions, VBHTMLRenderer, numerous feature requests and bug reports, several rule suggestions derived from <a href="http://junit-addons.sf.net/">JUnit-Addons</a>, evangelism :-)</li>
<li>Ken Foskey - noticed bad link</li>
<li>Stephan Janssen - promoted PMD for <a href="https://jjguidelines.dev.java.net/">JJGuidelines</a></li>