From 5e7325ad784d5e1f4e6240b5965e2c48164229cb Mon Sep 17 00:00:00 2001
From: carlos <carlos@13f79535-47bb-0310-9956-ffa450edef68>
Date: Thu, 29 Sep 2005 23:01:26 +0000
Subject: [PATCH] Take checkstyle:report-internal from checkstyle:run Improve
 docs

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@292574 13f79535-47bb-0310-9956-ffa450edef68
---
 checkstyle/plugin.jelly | 71 +++++++++++++++++++++--------------------
 1 file changed, 36 insertions(+), 35 deletions(-)

diff --git a/checkstyle/plugin.jelly b/checkstyle/plugin.jelly
index 98b67112..b3df6eb6 100644
--- a/checkstyle/plugin.jelly
+++ b/checkstyle/plugin.jelly
@@ -39,20 +39,16 @@
     <assert:assertPluginAvailable groupId="maven" artifactId="maven-xdoc-plugin" minRelease="1.10" neededBy="${plugin.artifactId}"/>
   </j:if>
 
-  <!--
-     ========================================================================
-       Default goal.
-     ========================================================================
-  -->
-  <goal name="checkstyle" description="Perform checkstyle checks"
+
+  <!-- ======================================================================== -->
+
+  <goal name="checkstyle" description="Call checkstyle:report"
       prereqs="checkstyle:report"/>
 
-  <!--
-     ========================================================================
-       Initializations.
-     ========================================================================
-  -->
-  <goal name="checkstyle:init">
+
+  <!-- ======================================================================== -->
+
+  <goal name="checkstyle:init" description="Initialize plugin">
 
     <j:if test="${sourcesPresent == 'true'}">
 
@@ -97,14 +93,11 @@
 
   </goal>
 
-  <!--
-     ========================================================================
-       Generate a checkstyle report by running checkstyle on the project
-       source code.
-     ========================================================================
-  -->
+
+  <!-- ======================================================================== -->
+
   <goal name="checkstyle:report"
-    description="Perform checkstyle checks"
+    description="Run checkstyle on project source code and generate reports"
     prereqs="checkstyle:init">
 
     <j:if test="${sourcesPresent == 'true'}">
@@ -132,11 +125,15 @@
       </j:if>
 
       <attainGoal name="checkstyle:run"/>
+      <attainGoal name="checkstyle:report-internal"/>
     </j:if>
     
   </goal>
 
-  <goal name="checkstyle:run">
+
+  <!-- ======================================================================== -->
+
+  <goal name="checkstyle:run" description="Run checkstyle on the sources and generate the xml report">
 
     <!-- Create the directory for the checkstyle cache in case it doesn't 
          exist already -->
@@ -152,7 +149,7 @@
           </j:when>
           <j:otherwise>
             <echo>The locale defined in maven.xdoc.locale.default is invalid.</echo>
-            <echo>As Coutry code we'll use EN instead.</echo>
+            <echo>As Country code we'll use EN instead.</echo>
             <j:set var="localeCountry" value="EN"/>
           </j:otherwise>
     </j:choose>
@@ -205,7 +202,6 @@
         </j:forEach>
       </j:if>
 
-
       <ant:classpath>
           <ant:path refid="maven.dependency.classpath"/>
           <ant:pathelement path="${maven.build.dest}"/>
@@ -225,7 +221,14 @@
       </j:choose>
 
     </ant:checkstyle>
-      
+
+  </goal>
+
+
+  <!-- ======================================================================== -->
+
+  <goal name="checkstyle:report-internal" description="Generate xdocs from checkstyle xml report">
+
     <doc:jsl
       input="${maven.build.dir}/checkstyle-raw-report.xml"
       output="checkstyle-report.xml"
@@ -254,12 +257,10 @@
 
   </goal>
 
-  <!--
-     ========================================================================
-       Register a Checkstyle report to the "site" plugin.
-     ========================================================================
-  -->
-  <goal name="maven-checkstyle-plugin:register">
+
+  <!-- ======================================================================== -->
+
+  <goal name="maven-checkstyle-plugin:register" description="Register a Checkstyle report to the site plugin">
     <j:if test="${sourcesPresent == 'true'}">
       <doc:registerReport 
         name="Checkstyle" 
@@ -269,18 +270,18 @@
     </j:if>
   </goal>
   
-  <!--
-     ========================================================================
-       Deregister a Checkstyle report to the "site" plugin.
-     ========================================================================
-  -->
-  <goal name="maven-checkstyle-plugin:deregister">
+
+  <!-- ======================================================================== -->
+
+  <goal name="maven-checkstyle-plugin:deregister" description="Deregister a Checkstyle report to the site plugin.">
     <j:if test="${sourcesPresent == 'true'}">
       <doc:deregisterReport name="Checkstyle"/>
     </j:if>
   </goal>
 
 
+  <!-- ======================================================================== -->
+
   <!-- Generate a report filtering errors by severity -->
 
   <define:taglib uri="checkstyle">