Author: dennisl Date: Thu Jul 9 19:55:29 2009 New Revision: 792655 URL: http://svn.apache.org/viewvc?rev=792655&view=rev Log: o Follow our plugin documentation guidelines.
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-developed-checkstyle.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-property-expansion.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/multi-module-config.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/suppressions-filter.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt maven/plugins/trunk/maven-checkstyle-plugin/src/site/fml/faq.fml Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-checker-config.apt Thu Jul 9 19:55:29 2009 @@ -30,7 +30,7 @@ A custom {{{http://checkstyle.sourceforge.net/config.html#Checker}Checker configuration xml file}} can be defined and then referenced via a URL, File, or build classpath resource reference. - To reference a custom Checkstyle Checker configuration, use the <<configLocation>> parameter. + To reference a custom Checkstyle Checker configuration, use the <<<configLocation>>> parameter. +-----+ <project> @@ -40,6 +40,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>checkstyle.xml</configLocation> </configuration> @@ -50,11 +51,11 @@ </project> +-----+ - This example causes the Checkstyle plugin to check for a File named <<<checkstyle.xml>>> or a + This example causes the Checkstyle Plugin to check for a File named <<<checkstyle.xml>>> or a resource named <<<checkstyle.xml>>> within the compile scope of the dependencies or build extensions classpath. - There are 4 predefined Checkstyle configuration definitions that ship with the Checkstyle plugin, + There are 4 predefined Checkstyle configuration definitions that ship with the Checkstyle Plugin, the Sun Microsystems Definition is selected by default. * <<config/sun_checks.xml>> - Sun Microsystems Definition (default). 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=792655&r1=792654&r2=792655&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 Thu Jul 9 19:55:29 2009 @@ -29,7 +29,7 @@ We will guide you through creating a Maven project that produces a jar file of your custom checks. Then we'll include it in one of your projects by adding it - as a dependency to the Checkstyle plugin. + as a dependency to the Checkstyle Plugin. The plugin also provides the ability to define the {{{http://checkstyle.sourceforge.net/config.html#Packages}package names XML document}} @@ -75,7 +75,7 @@ <dependency> <groupId>checkstyle</groupId> <artifactId>checkstyle</artifactId> - <version>4.3</version> + <version>4.4</version> </dependency> </dependencies> </project> @@ -154,7 +154,7 @@ +-----+ -* Building a jar for your custom checks project +* Building a JAR for your custom checks project To be able to use your custom checks in other projects, you need to package and install them. To do that, just run this on the command line: @@ -163,10 +163,10 @@ mvn install +-----+ - This produces a jar file with the following contents and installs it into your + This produces a JAR file with the following contents and installs it into your local repository. -** <<<mycompany-checkstyle-checks-1.0.jar>>>. +** <<<mycompany-checkstyle-checks-1.0.jar>>> +-----+ mycompany-checkstyle-checks-1.0.jar @@ -213,14 +213,14 @@ </module> +-----+ -** Configure the Checkstyle plugin to use your custom checks +** Configure the Checkstyle Plugin to use your custom checks Finally we need to tell the other project that you want it to use your custom Checkstyle checks. In the <<<pom.xml>>> of that project, add the following configuration. <<Note:>> You have to specify a plugin dependency on - <mycompany-checkstyle-checks> in the <<<\<build\>>>> element of your + <<<mycompany-checkstyle-checks>>> in the <<<\<build\>>>> element of your <<<pom.xml>>>. It will not work inside the <<<\<reporting\>>>> element, because <<<\<reporting\>>>> does not support plugin dependencies. The rest of the configuration is done in the normal way in the <<<\<reporting\>>>> @@ -234,6 +234,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <dependencies> <dependency> <groupId>com.mycompany</groupId> @@ -249,6 +250,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>checkstyle.xml</configLocation> <packageNamesLocation>com/mycompany/checks/packagenames.xml</packageNamesLocation> Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-property-expansion.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-property-expansion.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-property-expansion.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/custom-property-expansion.apt Thu Jul 9 19:55:29 2009 @@ -54,7 +54,7 @@ </module> +-----+ - Example: <<<pom.xml>>> - Specifies the <<projectname>> property expansion that Checkstyle will use when + Example: <<<pom.xml>>> - Specifies the <<<projectname>>> property expansion that Checkstyle will use when encountering such a variable in the above Checker configuration. +-----+ @@ -65,6 +65,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>checkstyle.xml</configLocation> <propertyExpansion>projectname=whizbang</propertyExpansion> @@ -87,6 +88,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>checkstyle.xml</configLocation> <propertesLocation>${basedir}/checkstyle.properties</propertiesLocation> Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/multi-module-config.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/multi-module-config.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/multi-module-config.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/multi-module-config.apt Thu Jul 9 19:55:29 2009 @@ -27,7 +27,7 @@ Multimodule Configuration - Configuring the Checkstyle plugin for use within large multimodule projects + Configuring the Checkstyle Plugin for use within large multimodule projects can be done, but it requires a little setup. This example will use a mysterious project called <whizbang>. This is what @@ -50,8 +50,8 @@ We'll start by adding another sub project that will house our common configuration. Let's call it <build-tools>. In it we put the resources that we want to include. In this example, we will add configuration files for the - Checkstyle plugin. Configuration files for other plugins, like the PMD - plugin, can be included in the same subproject if you like. + Checkstyle Plugin. Configuration files for other plugins, like the PMD + plugin, can be included in the same subproject if you like. +-----+ whizbang @@ -78,7 +78,7 @@ Now we can include the Checkstyle configuration in the top level <<<pom.xml>>>. - <<Note:>> You have to specify a plugin dependency on <build-tools> in the + <<Note:>> You have to specify a plugin dependency on <<<build-tools>>> in the <<<\<build\>>>> element of your <<<pom.xml>>>. It will not work inside the <<<\<reporting\>>>> element, because <<<\<reporting\>>>> does not support plugin dependencies. The rest of the configuration is done in the normal way @@ -97,6 +97,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <dependencies> <dependency> <groupId>com.example.whizbang</groupId> @@ -112,6 +113,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>whizbang/checkstyle.xml</configLocation> <headerLocation>whizbang/LICENSE.txt</headerLocation> @@ -129,12 +131,12 @@ +-----+ Once you are done with that, ensure that you do not include - maven-checkstyle-plugin in your sub modules, as their definition and + the Maven Checkstyle Plugin in your sub modules, as their definition and configuration, will override the top level parent pom's definition. - Based on the Checkstyle plugin configuration above, the values of + Based on the Checkstyle Plugin configuration above, the values of <<<configLocation>>> and <<<headerLocation>>> will be resolved from the - classpath. The <build-tools> jar was included in the classpath when it was + classpath. The <build-tools> JAR was included in the classpath when it was declared as a dependency to the plugin. Lastly, kick off a build of the site. Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/suppressions-filter.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/suppressions-filter.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/suppressions-filter.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/examples/suppressions-filter.apt Thu Jul 9 19:55:29 2009 @@ -60,6 +60,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <configLocation>checkstyle.xml</configLocation> <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation> Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt Thu Jul 9 19:55:29 2009 @@ -29,10 +29,10 @@ Maven Checkstyle Plugin - The Checkstyle plugin generates report regarding the code style used by the developers. For more information about Checkstyle, + The Checkstyle Plugin generates a report regarding the code style used by the developers. For more information about Checkstyle, see {{{http://checkstyle.sourceforge.net/}http://checkstyle.sourceforge.net/}} - The plugin can be configured in the project's pom. Predefined rulesets are included with the plugin, these are: + The plugin can be configured in the project's POM. Predefined rulesets are included with the plugin, these are: <<<sun_checks.xml>>>, <<<turbine_checks.xml>>>, <<<avalon_checks.xml>>> and <<<maven_checks.xml>>>. You can also use a custom ruleset by specifying it in the plugin configuration. Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/usage.apt Thu Jul 9 19:55:29 2009 @@ -29,12 +29,12 @@ Usage - The following examples describe the basic usage of the Checkstyle plugin. + The following examples describe the basic usage of the Checkstyle Plugin. * Generate Checkstyle Report As Part of the Project Reports To generate the Checkstyle report as part of the Project Reports, add the - Checkstyle plugin in the <<<\<reporting\>>>> section + Checkstyle Plugin in the <<<\<reporting\>>>> section of your <<<pom.xml>>>. +-----+ @@ -45,6 +45,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> </plugin> </plugins> </reporting> @@ -52,7 +53,7 @@ </project> +-----+ - Then, execute the site plugin to generate the report. + Then, execute the site phase to generate the report. +-----+ mvn site @@ -61,14 +62,14 @@ * Generate Checkstyle Report As Standalone You can also generate the Checkstyle report by explicitly executing the <<<checkstyle:checkstyle>>> goal from the - command line. It is not required to specify the Checkstyle plugin in your + command line. It is not required to specify the Checkstyle Plugin in your <<<pom.xml>>> unless you want to use a specific configuration. +-----+ mvn checkstyle:checkstyle +-----+ - To specifically configure the Checkstyle plugin, you need to the add it in the + To specifically configure the Checkstyle Plugin, you need to the add it in the <<<\<build\>>>> section of your <<<pom.xml>>> as shown in the sample below. @@ -80,6 +81,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.3</version> <configuration> <enableRulesSummary>false</enableRulesSummary> ... Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/fml/faq.fml URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/fml/faq.fml?rev=792655&r1=792654&r2=792655&view=diff ============================================================================== --- maven/plugins/trunk/maven-checkstyle-plugin/src/site/fml/faq.fml (original) +++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/fml/faq.fml Thu Jul 9 19:55:29 2009 @@ -25,8 +25,8 @@ <question>How are the Checkstyle properties set?</question> <answer> <p> - You can set the Checkstyle properties to be used in the plugin configuration of your pom through the - <strong>propertiesLocation</strong> parameter. The properties file will be resolved by the plugin based + You can set the Checkstyle properties to be used in the plugin configuration of your POM through the + <code>propertiesLocation</code> parameter. The properties file will be resolved by the plugin based on its value. </p> </answer> @@ -35,7 +35,7 @@ <question>How do I set a custom ruleset?</question> <answer> <p> - You can set a custom ruleset through the <strong>configLocation</strong> plugin parameter. If no value is + You can set a custom ruleset through the <code>configLocation</code> plugin parameter. If no value is specified, the plugin will use a default ruleset, which is the <code>sun_checks.xml</code>, that is bundled with the plugin. </p> @@ -46,7 +46,7 @@ <answer> <p> You can include the test directory in the Checkstyle report by setting the - <strong>includeTestSourceDirectory</strong> plugin parameter to <strong>true</strong>. + <code>includeTestSourceDirectory</code> plugin parameter to <code>true</code>. </p> </answer> </faq>