Update the javadoc plugin's properties and docs
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115446 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier
@@ -20,23 +20,32 @@
|
||||
# Javadoc plugin.
|
||||
# -------------------------------------------------------------------
|
||||
|
||||
#maven.javadoc.additionalparam
|
||||
maven.javadoc.author = true
|
||||
#maven.javadoc.customtags
|
||||
maven.javadoc.destdir = ${maven.docs.dest}/apidocs
|
||||
|
||||
# optional properties for specifying a custom doclet
|
||||
#maven.javadoc.docletpath=
|
||||
#maven.javadoc.doclet=
|
||||
#maven.javadoc.docletpath=
|
||||
|
||||
maven.javadoc.links =
|
||||
#maven.javadoc.maxmemory
|
||||
maven.javadoc.public = false
|
||||
maven.javadoc.package = true
|
||||
maven.javadoc.private = false
|
||||
maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css
|
||||
maven.javadoc.use = true
|
||||
maven.javadoc.version = true
|
||||
maven.javadoc.useexternalfile = yes
|
||||
maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
|
||||
|
||||
#specify an alternate locale
|
||||
#maven.javadoc.locale=en_US
|
||||
#maven.javadoc.maxmemory
|
||||
|
||||
#maven.javadoc.mode.online
|
||||
#maven.javadoc.offlineLinks
|
||||
#maven.javadoc.overview
|
||||
maven.javadoc.package = true
|
||||
maven.javadoc.private = false
|
||||
maven.javadoc.public = false
|
||||
#maven.javadoc.source
|
||||
maven.javadoc.stylesheet = ${plugin.resources}/stylesheet.css
|
||||
#maven.javadoc.tagletpath
|
||||
#maven.javadoc.taglets
|
||||
maven.javadoc.use = true
|
||||
maven.javadoc.useexternalfile = yes
|
||||
maven.javadoc.version = true
|
||||
maven.javadoc.windowtitle = ${pom.name} ${pom.currentVersion} API
|
||||
@@ -16,18 +16,30 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
-->
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Javadoc Properties</title>
|
||||
<author email="smor@apache.org">Stéphane MOR</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Javadoc Settings">
|
||||
<section name="Javadoc Settings">
|
||||
<table>
|
||||
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<th>Property</th>
|
||||
<th>Optional?</th>
|
||||
<th>Description</th>
|
||||
</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>
|
||||
<tr>
|
||||
<td>maven.javadoc.author</td>
|
||||
<td>Yes</td>
|
||||
@@ -38,6 +50,29 @@
|
||||
The default value is <code>true</code>.
|
||||
</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.destdir</td>
|
||||
<td>Yes</td>
|
||||
@@ -66,17 +101,6 @@
|
||||
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>
|
||||
@@ -108,7 +132,18 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a></td>
|
||||
<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>
|
||||
<a name="maven.javadoc.mode.online">maven.javadoc.mode.online</a>
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
@@ -160,9 +195,18 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.javadoc.overview</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
maven.javadoc.public<br />
|
||||
maven.javadoc.package<br />
|
||||
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.public<br/>
|
||||
maven.javadoc.package<br/>
|
||||
maven.javadoc.private
|
||||
</td>
|
||||
<td>Yes</td>
|
||||
@@ -173,24 +217,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
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>
|
||||
@@ -200,6 +226,26 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
ant javadoc task</a> documentation for more detail.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.javadoc.stylesheet</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Specifies the stylesheet file to use for the javadoc.
|
||||
Default is <code>${plugin.resources}/stylesheet.css</code>
|
||||
</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.taglets</td>
|
||||
<td>Yes</td>
|
||||
@@ -212,16 +258,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
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>
|
||||
@@ -231,6 +267,15 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
The default value is <code>true</code>.
|
||||
</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.version</td>
|
||||
<td>Yes</td>
|
||||
@@ -251,50 +296,6 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
|
||||
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>
|
||||
|
||||
Reference in New Issue
Block a user