You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/02/02 22:20:20 UTC

svn commit: r617897 - /maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt

Author: dennisl
Date: Sat Feb  2 13:20:11 2008
New Revision: 617897

URL: http://svn.apache.org/viewvc?rev=617897&view=rev
Log:
[MCHECKSTYLE-69] Improve documentation related to custom developed Checkstyle check modules

Modified:
    maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt

Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt?rev=617897&r1=617896&r2=617897&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt (original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt Sat Feb  2 13:20:11 2008
@@ -30,7 +30,7 @@
    {{{http://checkstyle.sourceforge.net/config.html#Packages}package names definition}} required to
    reference your custom check modules.
 
-   TIP: Create a maven project that produces a jar file of your custom checks, and then include it in your
+   <<TIP:>> Create a maven project that produces a jar file of your custom checks, and then include it in your
    projects using the maven build extension in the pom.xml to avoid them being included in the compile or
    package phases of your project.
 
@@ -74,7 +74,7 @@
 
 +-----+
 <project>
-   ...
+  ...
   <reporting>
     <plugins>
       <plugin>
@@ -84,18 +84,16 @@
           <configLocation>checkstyle.xml</configLocation>
           <packageNamesLocation>com/mycompany/checkstyle/packagenames.xml</packageNamesLocation>
         </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>com.mycompany</groupId>
+            <artifactId>mycompany-checkstyle-checks</artifactId>
+            <version>1.0</version>
+          </dependency>
+        </dependencies>
       </plugin>
     </plugins>
   </reporting>
-   ...
-  <build>
-    <extensions>
-      <extension>
-        <groupId>com.mycompany</groupId>
-        <artifactId>mycompany-checkstyle-checks</artifactId>
-        <version>1.0</version>
-      </extension>
-    </extensions>
-  </build>
+  ...
 </project>
 +-----+