svn commit: r418222 - /maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java

[ep...@apache.org]

Author: epunzalan
Date: Fri Jun 30 03:01:33 2006
New Revision: 418222

URL: http://svn.apache.org/viewvc?rev=418222&view=rev
Log:
Fixed bug in previous commit which still prints messages even when there are no doc errors/warns.

Improved the messages when ran in a multi-project environment.

Modified:
    maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java

Modified: maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java?rev=418222&r1=418221&r2=418222&view=diff
==============================================================================
--- maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java (original)
+++ maven/sandbox/plugins/maven-docck-plugin/src/main/java/org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.java Fri Jun 30 03:01:33 2006
@@ -107,7 +107,7 @@
             getLog().info( "Writing documentation survey results to: " + output );
         }
 
-        Map errors = new LinkedHashMap();
+        Map reporters = new LinkedHashMap();
         boolean hasErrors = false;
 
         for ( Iterator it = reactorProjects.iterator(); it.hasNext(); )
@@ -127,7 +127,7 @@
                     hasErrors = true;
                 }
 
-                errors.put( project, reporter );
+                reporters.put( project, reporter );
             }
             else
             {
@@ -137,7 +137,7 @@
 
         String messages;
 
-        messages = buildErrorMessages( errors );
+        messages = buildErrorMessages( reporters );
 
         if ( !hasErrors )
         {
@@ -169,40 +169,36 @@
         }
     }
 
-    private String buildErrorMessages( Map errors )
+    private String buildErrorMessages( Map reporters )
     {
         String messages;
         StringBuffer buffer = new StringBuffer();
 
-        if ( errors.size() > 0 )
+        for ( Iterator it = reporters.entrySet().iterator(); it.hasNext(); )
         {
-            buffer.append( "\nThe following documentation problems were found:\n" );
+            Map.Entry entry = (Map.Entry) it.next();
 
-            for ( Iterator it = errors.entrySet().iterator(); it.hasNext(); )
-            {
-                Map.Entry entry = (Map.Entry) it.next();
+            MavenProject project = (MavenProject) entry.getKey();
+            DocumentationReporter reporter = (DocumentationReporter) entry.getValue();
 
-                MavenProject project = (MavenProject) entry.getKey();
-                DocumentationReporter reporter = (DocumentationReporter) entry.getValue();
+            if ( !reporter.getMessages().isEmpty() )
+            {
+                buffer.append( "\nThe following documentation problems were found in " +
+                               project.getArtifactId() + ":\n" );
 
-                if ( !reporter.getMessages().isEmpty() )
+                buffer.append( "\no " ).append( project.getName() );
+                buffer.append( " (" ).append( reporter.getMessagesByType( DocumentationReport.TYPE_ERROR ).size() )
+                      .append( " errors," );
+                buffer.append( " " ).append( reporter.getMessagesByType( DocumentationReport.TYPE_WARN ).size() )
+                      .append( " warnings)" );
+                for ( Iterator errorIterator = reporter.getMessages().iterator(); errorIterator.hasNext(); )
                 {
-                    buffer.append( "\no " ).append( project.getName() );
-                    int numberOfErrors = reporter.getMessagesByType( DocumentationReport.TYPE_ERROR ).size();
-                    buffer.append( " (" ).append( numberOfErrors )
-                          .append( " error" ).append( numberOfErrors != 1 ? "s" : "" ).append( "," );
-                    int numberOfWarnings = reporter.getMessagesByType( DocumentationReport.TYPE_WARN ).size();
-                    buffer.append( " " ).append( numberOfWarnings )
-                          .append( " warning" ).append( numberOfWarnings != 1 ? "s" : "" ).append( ")" );
-                    for ( Iterator errorIterator = reporter.getMessages().iterator(); errorIterator.hasNext(); )
-                    {
-                        String error = (String) errorIterator.next();
+                    String error = (String) errorIterator.next();
 
-                        buffer.append( "\n\t" ).append( error );
-                    }
-
-                    buffer.append( "\n" );
+                    buffer.append( "\n\t" ).append( error );
                 }
+
+                buffer.append( "\n" );
             }
         }
 
@@ -475,4 +471,4 @@
 
         return includedFiles != null && includedFiles.length > 0;
     }
-}
\ No newline at end of file
+}