7835460f41
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114565 13f79535-47bb-0310-9956-ffa450edef68
284 lines
10 KiB
XML
284 lines
10 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>
|
|
Boolean value.
|
|
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.links</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Comma separated list of URLs to create links to javadoc output of
|
|
other packages in online mode (see properties maven.online.mode and
|
|
<a href="#maven.javadoc.mode.online">maven.javadoc.mode.online</a>).
|
|
Works like the "-link" option of the javadoc command.
|
|
</p>
|
|
<p>
|
|
The URLs must link to a directory where the javadoc generated file
|
|
"package-list" is accesible for the package.
|
|
</p>
|
|
<p>Example:</p>
|
|
<source>
|
|
maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/
|
|
</source>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.locale</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Locale to be used, e.g. en_US or en_US_WIN.
|
|
Works like the "-locale" option of the javadoc command.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a></td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Default value is <code>${maven.mode.online}</code>.
|
|
</p>
|
|
<p>
|
|
If set, a value of <code>true</code> forces generation of javadoc in
|
|
online mode (using <code>${maven.javadoc.links}</code>).
|
|
</p>
|
|
<p>
|
|
Any other value means <code>false</code> and forces generation of javadoc
|
|
in offline mode (using <code>${maven.javadoc.offlineLinks}</code>).
|
|
</p>
|
|
<p>
|
|
This tag allows you to generate javadoc in mode different from the
|
|
"general" online/offline mode <code>${maven.mode.online}</code>.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.offlineLinks</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Comma separated list of URLs to create links to javadoc output of
|
|
other packages in offline mode (see properties maven.online.mode and
|
|
<a href="#maven.javadoc.mode.online">maven.javadoc.mode.online</a>).
|
|
Works like the "-linkoffline" option of the javadoc command.
|
|
</p>
|
|
<p>
|
|
The URLs must link to a directory where the javadoc generated file
|
|
"package-list" is accesible for the package.
|
|
</p>
|
|
<p>Example (generates <b>offline</b> links in offline mode):</p>
|
|
<source>
|
|
maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/
|
|
</source>
|
|
<p>
|
|
Generation of online javadoc links in offline mode is also possible.
|
|
You need to provide the online URL plus the a offline directory
|
|
resource for "package-list". URL and directory need to be seperated
|
|
by the "#" character.
|
|
</p>
|
|
<p>Example (generates <b>online</b> links in offline mode):</p>
|
|
<source>
|
|
maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apidoc/j2sdk1.4.1/docs/api/, \
|
|
http://maven.apache.org/apidocs/#/cvsroot/maven/target/docs/apidocs/
|
|
</source>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
maven.javadoc.public<br />
|
|
maven.javadoc.package<br />
|
|
maven.javadoc.private
|
|
</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Boolean value.
|
|
The scope of classes and members to include in the javadoc.
|
|
A <code>true</code> value includes that scope and higher.
|
|
The default value is to include protected scope and higher.
|
|
</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.overview</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Filename.
|
|
Add additional overview documentation to the overview page of the javadoc.
|
|
The documentation must be an HTML file, specified relative to the project.xml.
|
|
</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.taglets</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Comma separated list of taglet classes to use when calling javadoc
|
|
(use fully-qualified class names).
|
|
You must also set <a href="#maven.javadoc.tagletpath">
|
|
maven.javadoc.tagletpath</a>.
|
|
See <a href="http://ant.apache.org/manual/CoreTasks/javadoc.html">the
|
|
ant javadoc task</a> documentation for more detail.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a name="maven.javadoc.tagletpath">maven.javadoc.tagletpath</a></td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the path to the taglet classes when calling javadoc
|
|
with taglets. 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>
|
|
Boolean value.
|
|
If <code>true</code>, 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>${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>
|
|
<tr>
|
|
<td>maven.javadoc.useexternalfile</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
indicates whether the sourcefile name specified in srcfiles or as
|
|
nested source elements should be written to a temporary file to make
|
|
the command line shorter. Default value : no.
|
|
</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>
|
|
<tr>
|
|
<td>maven.javadoc.additionalparam</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies additional parameters added to the javadoc command line.
|
|
<p>Example (sets generated Javadocs encoding to utf-8):</p>
|
|
<source>
|
|
maven.javadoc.additionalparam=-charset utf-8
|
|
</source>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|