28e1924ac4
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113166 13f79535-47bb-0310-9956-ffa450edef68
145 lines
4.6 KiB
XML
145 lines
4.6 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Javadoc Properties</title>
|
|
<author email="smor@apache.org">Stéphane MOR</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Javadoc Settings">
|
|
<table>
|
|
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
|
<tr>
|
|
<td>maven.javadoc.author</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies whether or not the <code>@author</code> text is
|
|
included in the generated Javadocs. The default value is
|
|
<code>true</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.destdir</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The destination directory for all of the generated
|
|
Javadocs. The default value is
|
|
<code>${maven.docs.dest}/apidocs</code>.
|
|
</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.
|
|
</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.doctitle</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the document title to use for the generated
|
|
Javadocs. The default value is <code>${maven.name}
|
|
${maven.currentVersion} API</code>. <code>${maven.name}</code>
|
|
and <code>${maven.currentVersion}</code> expand to values obtained
|
|
from the project descriptor.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.private</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies whether or not all classes and members are
|
|
included in the generated Javadocs. The default value is
|
|
<code>false</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.maxmemory</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the maximum Java heap size to be used when launching
|
|
the javadoc executable. Some JVMs refer to this property as
|
|
the <code>-Xmx</code> parameter.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.source</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the version of the jdk in use. 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.use</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies whether or not a "use" page is generated for
|
|
each class and member. The default value is
|
|
<code>true</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.version</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies whether or not the <code>@version</code> text is
|
|
included in the generated Javadocs. The default value is
|
|
<code>true</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.windowtitle</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the window title to use for the generated
|
|
Javadocs. The default value is <code>${maven.name}
|
|
${maven.currentVersion} API</code>. <code>${maven.name}</code>
|
|
and <code>${maven.currentVersion}</code> expand to values obtained
|
|
from the project descriptor.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.customtags</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies custom tags to use for the generated
|
|
Javadocs. You can specify some tags separate by space.
|
|
Each tag is describe in sub properties.
|
|
This option is only available with Java 1.4.
|
|
Sample :
|
|
<source><![CDATA[
|
|
maven.javadoc.customtags=tag1 tag2
|
|
tag1.name=todo
|
|
tag1.description=To Do:
|
|
tag1.enabled=true
|
|
tag1.scope=all
|
|
|
|
tag2.name=task
|
|
tag2.description=Task:
|
|
tag2.enabled=false
|
|
tag2.scope=all
|
|
]]>
|
|
</source>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|