Author: jjensen
Date: Sat Apr 21 07:45:10 2007
New Revision: 531042
URL: http://svn.apache.org/viewvc?view=rev&rev=531042
Log:
Create "alternate doclet settings" section, and move the existing 3 properties
to it.
Modified:
maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml
Modified: maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml?view=diff&rev=531042&r1=531041&r2=531042
==============================================================================
--- maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml Sat Apr 21
07:45:10 2007
@@ -57,37 +57,6 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.doclet</td>
- <td>Yes</td>
- <td>
- Specifies the doclet to use when calling javadoc. See
- <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
- ant javadoc task</a> documentation for more detail.
- See <a href="faq.html#classdiagrams">Class Diagrams FAQ</a>
- as an example.
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.docletpath</td>
- <td>Yes</td>
- <td>
- Specifies the path to the doclet class when calling javadoc with a
- custom doclet. See
- <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
- ant javadoc task</a> documentation for more detail.
- </td>
- </tr>
- <tr>
- <td>maven.javadoc.usestandardparameters</td>
- <td>Yes</td>
- <td>
- If this option is set, javadoc will use the standard doclet
- parameters (see <a href="#Standard_Doclet_Settings">below</a>)
- even if the <code>maven.javadoc.doclet</code> option is set.
- This is useful for doclets that extend the standard one.
- </td>
- </tr>
- <tr>
<td>maven.javadoc.excludepackagenames</td>
<td>Yes</td>
<td>
@@ -364,6 +333,50 @@
<code>${pom.name} ${pom.currentVersion} API</code>.
<code>${pom.name}</code> and <code>${maven.currentVersion}</code>
expand to values obtained from the project descriptor.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Alternate Doclet Settings">
+ <table>
+ <tr>
+ <th>Type</th>
+ <th>Name</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.javadoc.doclet</td>
+ <td>Yes</td>
+ <td>
+ Specifies the doclet to use when calling javadoc. See
+ <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
+ ant javadoc task</a> documentation for more detail.
+ See <a href="faq.html#classdiagrams">Class Diagrams FAQ</a>
+ as an example.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.javadoc.docletpath</td>
+ <td>Yes</td>
+ <td>
+ Specifies the path to the doclet class when calling javadoc with a
+ custom doclet. See
+ <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
+ ant javadoc task</a> documentation for more detail.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.javadoc.usestandardparameters</td>
+ <td>Yes</td>
+ <td>
+ If this option is set (to a any value), javadoc will use the
standard doclet
+ parameters (see <a href="#Standard_Doclet_Settings">above</a>)
+ even if the <code>maven.javadoc.doclet</code> option is set.
+ This is useful for doclets that extend the standard one.
+ When specifying an alternate doclet,
+ the plugin does not use the standard doclet parameters
+ unless this property is set.
</td>
</tr>
</table>
