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

[vs...@apache.org]

Author: vsiveton
Date: Sat Oct 20 06:26:45 2007
New Revision: 586711

URL: http://svn.apache.org/viewvc?rev=586711&view=rev
Log:
MJAVADOC-160: Validate javadoc options and standard doclet options

o improved doc

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

Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=586711&r1=586710&r2=586711&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java Sat Oct 20 06:26:45 2007
@@ -439,6 +439,8 @@
      * Specifies that javadoc should retrieve the text for the overview documentation from the "source" file
      * specified by path/filename and place it on the Overview page (overview-summary.html).
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;nooverview/&gt;.
+     * <br/>
      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overview">overview</a>.
      *
      * @parameter expression="${overview}" default-value="${basedir}/src/main/javadoc/overview.html"
@@ -649,6 +651,8 @@
      * Specifies the path of an alternate help file path\filename that the HELP link in the top and bottom
      * navigation bars link to.
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;nohelp/&gt;.
+     * <br/>
      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#helpfile">helpfile</a>.
      *
      * @parameter expression="${helpfile}"
@@ -746,6 +750,8 @@
     /**
      * Omits the HELP link in the navigation bars at the top and bottom of each page of output.
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;helpfile/&gt;.
+     * <br/>
      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#nohelp">nohelp</a>.
      *
      * @parameter expression="${nohelp}" default-value="false"
@@ -755,6 +761,8 @@
     /**
      * Omits the index from the generated docs.
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;splitindex/&gt;.
+     * <br/>
      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#noindex">noindex</a>.
      *
      * @parameter expression="${noindex}" default-value="false"
@@ -773,6 +781,8 @@
     /**
      * Omits the entire overview page from the generated docs.
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;overview/&gt;.
+     * <br/>
      * Standard Doclet undocumented option.
      *
      * @since 2.4
@@ -863,6 +873,8 @@
      * Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index
      * entries that start with non-alphabetical characters.
      * <br/>
+     * <b>Note</b>: could be in conflict with &lt;noindex/&gt;.
+     * <br/>
      * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#splitindex">splitindex</a>.
      *
      * @parameter expression="${splitindex}" default-value="false"
@@ -2857,7 +2869,7 @@
     /**
      * Checks for the validity of the Standard Doclet options.
      * <br/>
-     * For example, throw an exception if &lt;nohelp&gt; and &lt;helpfile&gt; options are used together.
+     * For example, throw an exception if &lt;nohelp/&gt; and &lt;helpfile/&gt; options are used together.
      *
      * @throws MavenReportException if error or conflict found
      */