6dacf1ef52
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@531612 13f79535-47bb-0310-9956-ffa450edef68
491 lines
16 KiB
XML
491 lines
16 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!--
|
|
/*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership.
|
|
* The ASF licenses this file to You under the Apache License, Version 2.0
|
|
* (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
<document>
|
|
<properties>
|
|
<title>Javadoc Properties</title>
|
|
<author email="smor@apache.org">Stéphane MOR</author>
|
|
<author email="aheritier@apache.org">Arnaud HERITIER</author>
|
|
</properties>
|
|
<body>
|
|
<section name="Javadoc Settings">
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.additionalparam</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies additional parameters added to the javadoc command line.
|
|
<p>Example (to print what version of javadoc you are using):</p>
|
|
<source>maven.javadoc.additionalparam=-J-showversion</source>
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.extrasourcepath</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
A colon- or semicolon-separated list of paths that are added
|
|
to the <code>sourcepath</code> parameter of the ant javadoc task.
|
|
This can be used to add paths for inherited javadocs.
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.debug</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Print informations to debug the plugin.
|
|
</td>
|
|
<td>false</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.excludepackagenames</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Comma separated list of packages to exclude from the javadoc.
|
|
</td>
|
|
<td>(none)</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>
|
|
<td>(none)</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>
|
|
<td>512m</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>
|
|
<td>(none)</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.
|
|
</td>
|
|
<td>protected scope and higher</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>
|
|
<td>(none)</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.
|
|
</td>
|
|
<td>no</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.failonerror</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Stop the buildprocess if the command exits with a returncode other
|
|
than 0.
|
|
</td>
|
|
<td>false</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.javadocreport</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Include the javadoc report.
|
|
</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.warningsreport</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Include the javadoc warnings report.
|
|
</td>
|
|
<td>true</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Standard Doclet Settings">
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
<th>Default</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.
|
|
</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.bottom</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the text to be placed at the bottom of each output file.
|
|
<code>${pom.organization.name}</code>
|
|
expands to value obtained from the project descriptor.
|
|
</td>
|
|
<td>
|
|
Copyright ${year} ${pom.organization.name}. All Rights Reserved.
|
|
</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>
|
|
<strong>Note</strong>: Due to a bug in the jexl expression evaluator,
|
|
custom tag names defined by this property cannot contain dashes.
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.destdir</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The destination directory for all of the generated
|
|
Javadocs.
|
|
</td>
|
|
<td>${maven.docs.dest}/apidocs</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.footer</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the text or html fragment to be placed to the right of the bottom navigation bar
|
|
on all pages.
|
|
If the footer is not set,
|
|
but the header is, then Javadoc will use the header in both places.
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.header</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the text or html fragment to be placed at the top of the navigation frame in the upper-left corner,
|
|
and to the right of the top navigation bar on all pages.
|
|
Javadoc will be use this as the footer as well if the footer is not set explicitly.
|
|
</td>
|
|
<td>(none)</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>See the <a href="faq.html#links">FAQ</a> for more details.</p>
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a>
|
|
</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<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>
|
|
<td>${maven.mode.online}</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>See the <a href="faq.html#offlineLinks">FAQ</a> for more details.</p>
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.stylesheet</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the stylesheet file to use for the javadoc.
|
|
</td>
|
|
<td>${plugin.resources}/stylesheet.css</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>
|
|
<td>(none)</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>
|
|
<td>(none)</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.
|
|
</td>
|
|
<td>true</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.
|
|
</td>
|
|
<td>true</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.windowtitle</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the window title and the doc title to use for the generated
|
|
Javadocs.
|
|
<code>${pom.name}</code> and <code>${maven.currentVersion}</code>
|
|
expand to values obtained from the project descriptor.
|
|
</td>
|
|
<td>${pom.name} ${pom.currentVersion} API</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Alternate Doclet Settings">
|
|
<table>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
<th>Default</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>
|
|
<td>(none - calls the JavaDoc standard doclet)</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>
|
|
<td>(none)</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>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.doclet.param.list</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Delimeter separated list of property names
|
|
(see maven.javadoc.doclet.param.list.delim),
|
|
with each property defining a parameter name and value,
|
|
to pass to the doclet.
|
|
For example: <code>umlgraph.all,property2.abc,property3.def</code>
|
|
</p>
|
|
<p>
|
|
For every property listed, it expects 2 additional properties:
|
|
<dl>
|
|
<dt>(propertyname).name</dt>
|
|
<dd>The name of the parameter to pass to the doclet.</dd>
|
|
<dt>(propertyname).value</dt>
|
|
<dd>
|
|
The value of the parameter to pass to the doclet.
|
|
Note that this can be not specified,
|
|
if the parameter name is all that is needed.
|
|
</dd>
|
|
</dl>
|
|
</p>
|
|
<p>
|
|
For example, to specify the "-all" parameter to the doclet
|
|
and "-all" does not have a parameter value:
|
|
<source>
|
|
maven.javadoc.doclet.param.list=umlgraph.all
|
|
umlgraph.all.name=-all
|
|
</source>
|
|
</p>
|
|
</td>
|
|
<td>(none)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.javadoc.doclet.param.list.delim</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
<p>
|
|
Property name delimeter for list of parameters specified in
|
|
maven.javadoc.doclet.param.list.
|
|
</p>
|
|
</td>
|
|
<td>, (comma)</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section name="Other Settings">
|
|
<table>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Optional?</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Property</td>
|
|
<td>maven.compile.encoding</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Sets the encoding of the .java files being documented (and compiled).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Property</td>
|
|
<td>maven.docs.outputencoding</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The character encoding for generated documentation. This value is used as charset and docencoding for the standard doclet.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Project descriptor</td>
|
|
<td>pom.package</td>
|
|
<td nowrap="nowrap">No (<= 1.6)<br/><b>Yes (>= 1.7)</b></td>
|
|
<td>
|
|
The package used as root for the javadoc.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
</body>
|
|
</document>
|