You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/07/15 13:03:48 UTC

svn commit: r794232 - /maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java

Author: vsiveton
Date: Wed Jul 15 11:03:48 2009
New Revision: 794232

URL: http://svn.apache.org/viewvc?rev=794232&view=rev
Log:
MJAVADOC-230: aggregate report requires to have aggregate=true configuration parameter

o added javadoc to describe the logic

Modified:
    maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=794232&r1=794231&r2=794232&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Wed Jul 15 11:03:48 2009
@@ -134,7 +134,70 @@
         return true;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <br/>
+     * The logic is the following:
+     * <table>
+     *   <tbody>
+     *     <tr>
+     *       <th> isAggregator </th>
+     *       <th> hasSourceFiles </th>
+     *       <th> isRootProject </th>
+     *       <th> Generate Report </th>
+     *     </tr>
+     *     <tr>
+     *       <td>True</td>
+     *       <td>True</td>
+     *       <td>True</td>
+     *       <td>True</td>
+     *     </tr>
+     *     <tr>
+     *       <td>True</td>
+     *       <td>True</td>
+     *       <td>False</td>
+     *       <td>False</td>
+     *     </tr>
+     *     <tr>
+     *       <td>True</td>
+     *       <td>False</td>
+     *       <td>True</td>
+     *       <td>False</td>
+     *     </tr>
+     *     <tr>
+     *       <td>True</td>
+     *       <td>False</td>
+     *       <td>False</td>
+     *       <td>False</td>
+     *     </tr>
+     *     <tr>
+     *       <td>False</td>
+     *       <td>True</td>
+     *       <td>True</td>
+     *       <td>True</td>
+     *     </tr>
+     *     <tr>
+     *       <td>False</td>
+     *       <td>True</td>
+     *       <td>False</td>
+     *       <td>True</td>
+     *     </tr>
+     *     <tr>
+     *        <td>False</td>
+     *        <td>False</td>
+     *        <td>True</td>
+     *        <td>False</td>
+     *      </tr>
+     *      <tr>
+     *        <td>False</td>
+     *        <td>False</td>
+     *        <td>False</td>
+     *        <td>False</td>
+     *      </tr>
+     *    </tbody>
+     *  </table>
+     */
     public boolean canGenerateReport()
     {
         boolean canGenerate = false;