You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by be...@apache.org on 2008/04/18 20:43:21 UTC
svn commit: r649649 - in /maven/plugins/trunk/maven-pmd-plugin/src/site/apt:
examples/removeReport.apt examples/targetJdk.apt examples/usingRuleSets.apt
examples/violationChecking.apt index.apt usage.apt
Author: bentmann
Date: Fri Apr 18 11:43:18 2008
New Revision: 649649
URL: http://svn.apache.org/viewvc?rev=649649&view=rev
Log:
o Polished site docs
Modified:
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/removeReport.apt Fri Apr 18 11:43:18 2008
@@ -41,6 +41,7 @@
<plugins>
<plugin>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
<reportSets>
<reportSet>
<reports>
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/targetJdk.apt Fri Apr 18 11:43:18 2008
@@ -41,6 +41,7 @@
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
+ <version>2.0.2</version>
<configuration>
<source>${compileSource}</source>
</configuration>
@@ -52,6 +53,7 @@
<plugins>
<plugin>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<targetJdk>${compileSource}</targetJdk>
</configuration>
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/usingRuleSets.apt Fri Apr 18 11:43:18 2008
@@ -29,7 +29,7 @@
Using Rule Sets
The PMD plugin uses three default rule sets: <basic.xml>, <unusedcode.xml> and <imports.xml>. These rule sets are
- bundled in the PMD code analysis tool ({{{http://pmd.sourceforge.net/rules/index.html}more info}}). To use other
+ bundled in the PMD code analysis tool (see the {{{http://pmd.sourceforge.net/rules/index.html}ruleset index}}). To use other
rule sets, you can configure it in the plugin as shown below.
The rule sets may reside in the classpath, filesystem or at a URL. For rule sets that are bundled with the PMD tool,
@@ -44,6 +44,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<rulesets>
<!-- Two rule sets that come bundled with PMD -->
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/examples/violationChecking.apt Fri Apr 18 11:43:18 2008
@@ -42,6 +42,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
<executions>
<execution>
<goals>
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/index.apt Fri Apr 18 11:43:18 2008
@@ -48,8 +48,17 @@
* Usage
- Instructions on how to use the PMD Plugin can be found {{{usage.html}here}}.
+ Instructions on how to use the PMD Plugin can be found on the {{{usage.html}usage page}}.
* Examples
- More advanced usecases for the plugin are available under the Examples menu.
+ To provide you with better understanding of some usages of the Maven PMD Plugin, you can take a look into the
+ following examples:
+
+ * {{{examples/removeReport.html}Remove Report}}
+
+ * {{{examples/targetJdk.html}Target JDK}}
+
+ * {{{examples/usingRuleSets.html}Using Rule Sets}}
+
+ * {{{examples/violationChecking.html}Violation Checking}}
Modified: maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt?rev=649649&r1=649648&r2=649649&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-pmd-plugin/src/site/apt/usage.apt Fri Apr 18 11:43:18 2008
@@ -28,7 +28,7 @@
The PMD plugin generates PMD and CPD reports using the PMD code analysis tool.
To include a report with default rule sets and configuration in your project site, set the following in the
- <<<\<reporting\>>>> section of your pom:
+ <<<\<reporting\>>>> section of your POM:
+-----+
<project>
@@ -38,6 +38,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
</plugin>
</plugins>
</reporting>
@@ -46,7 +47,7 @@
+-----+
You can also explicitly execute the PMD plugin and generate the same report by setting the plugin in the
- <<<\<build\>>>> section of your pom as shown below:
+ <<<\<build\>>>> section of your POM as shown below:
+-----+
<project>
@@ -56,6 +57,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
</plugin>
</plugins>
</build>
@@ -90,6 +92,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
+ <version>2.3</version>
<configuration>
<linkXref>true</linkXref>
<sourceEncoding>utf-8</sourceEncoding>