Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-javadoc-plugin:2.5:test-javadoc
Description:
Java Test code
in the
project using the standard Javadoc Tool
.Attributes:
test
.2.3
.generate-test-sources
prior to executing itself.Name | Type | Since | Description |
---|---|---|---|
outputDirectory | File |
2.3 |
Specifies the destination directory where javadoc saves the
generated HTML files. See d . Default value is: ${project.build.directory}/apidocs . |
reportOutputDirectory | File |
2.3 |
Specifies the destination directory where test Javadoc saves the
generated HTML files. |
Name | Type | Since | Description |
---|---|---|---|
additionalJOption | String |
2.3 |
Set an additional Javadoc option(s) (i.e. JVM options) on the
command line. Example:
<additionalJOption>-J-Xss128m</additionalJOption>See Jflag . See vmoptions . |
additionalparam | String |
2.3 |
Set an additional parameter(s) on the command line. This value
should include quotes as necessary for parameters that include
spaces. Useful for a custom doclet. |
aggregate | boolean |
2.3 |
Deprecated. {0}. As of version 2.5, use the goals javadoc:aggregate and
javadoc:test-aggregate instead.Default value is: false . |
author | boolean |
2.3 |
Specifies whether or not the author text is included in the
generated Javadocs. See author . Default value is: true . |
bootclasspath | String |
2.5 |
Specifies the paths where the boot classes reside. See bootclasspath . |
bootclasspathArtifacts | BootclasspathArtifact[] |
2.5 |
Specifies the artifacts where the boot classes reside. See bootclasspath . Example: <bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts> See Javadoc . |
bottom | String |
2.3 |
Specifies the text to be placed at the bottom of each output
file. If you want to use html you have to put it in a CDATA section, eg. <![CDATA[Copyright 2005, <a
href="http://www.mycompany.com">MyCompany,
Inc.<a>]]> See bottom . Default value is: Copyright � {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved. . |
breakiterator | boolean |
2.3 |
Uses the sentence break iterator to determine the end of the first
sentence. See breakiterator . Since Java 1.4 . Default value is: false . |
charset | String |
2.3 |
Specifies the HTML character set for this document. If not
specificed, the charset value will be the value of the
docencoding parameter. See charset . |
debug | boolean |
2.1 |
Set this to 'true' to debug Javadoc plugin. With this, 'options'
and 'files' files are provided. Default value is: false . |
description | String |
2.1 |
The description of the Javadoc report. |
destDir | String |
2.3 |
The name of the destination directory. Default value is: testapidocs . |
docencoding | String |
2.3 |
Specifies the encoding of the generated HTML files. If not
specificed, the docencoding value will be UTF-8 .
See docencoding . Default value is: ${project.reporting.outputEncoding} . |
docfilessubdirs | boolean |
2.3 |
Enables deep copying of "doc-files" directories. See docfilessubdirs . Since Java 1.4 . See javadocDirectory . Default value is: false . |
doclet | String |
2.3 |
Specifies the class file that starts the doclet used in generating
the documentation. See doclet . |
docletArtifact | DocletArtifact |
2.3 |
Specifies the artifact containing the doclet starting class file
(specified with the -doclet option). See docletpath . Example: <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> See Javadoc . |
docletArtifacts | DocletArtifact[] |
2.1 |
Specifies multiple artifacts containing the path for the doclet
starting class file (specified with the -doclet option). See docletpath . Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> See Javadoc . |
docletPath | String |
2.3 |
Specifies the path to the doclet starting class file (specified
with the -doclet option) and any jar files it depends on. The
docletPath can contain multiple paths by separating them with a
colon (: ) on Solaris and a semi-colon (; )
on Windows. See docletpath . |
doctitle | String |
2.3 |
Specifies the title to be placed near the top of the overview
summary file. See doctitle . Default value is: ${project.name} ${project.version} API . |
encoding | String |
2.3 |
Specifies the encoding name of the source files. If not specificed,
the encoding value will be the value of the
file.encoding system property. See encoding . Note : In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was
reverted in 2.5. Default value is: ${project.build.sourceEncoding} . |
excludePackageNames | String |
2.3 |
Unconditionally excludes the specified packages and their
subpackages from the list formed by -subpackages. Multiple packages
can be separated by colons (: ). See exclude . Since Java 1.4 . |
excludedocfilessubdir | String |
2.3 |
Excludes any "doc-files" subdirectories with the given names.
Multiple patterns can be excluded by separating them with colons
(: ). See excludedocfilessubdir . Since Java 1.4 . |
extdirs | String |
2.3 |
Specifies the directories where extension classes reside. Separate
directories in dirlist with a colon (: ) on Solaris and
a semi-colon (; ) on Windows. See extdirs . |
failOnError | boolean |
2.5 |
Specifies whether the build will continue even if there are errors. Default value is: true . |
footer | String |
2.3 |
Specifies the footer text to be placed at the bottom of each output
file. See footer . |
groups | Group[] |
2.3 |
Separates packages on the overview page into whatever groups you
specify, one group per table. The packages pattern can be any
package name, or can be the start of any package name followed by
an asterisk (* ) meaning "match any characters".
Multiple patterns can be included in a group by separating them
with colons (: ). See group . Example: <groups> <group> <title>Core Packages</title> <packages>org.apache.core</packages> </group> </groups> See Javadoc . |
header | String |
2.3 |
Specifies the header text to be placed at the top of each output
file. See header . |
helpfile | String |
2.3 |
Specifies the path of an alternate help file path\filename that the
HELP link in the top and bottom navigation bars link to. Note : could be in conflict with <nohelp/>. See helpfile . |
javadocDirectory | File |
2.1 |
Specifies the Javadoc resources directory to be included in the
Javadoc (i.e. package.html, images...). Could be used in addition of docfilessubdirs
parameter. See docfilessubdirs . |
javadocExecutable | String |
2.3 |
Sets the absolute path of the Javadoc Tool executable to use. Since
version 2.5, a mere directory specification is sufficient to have
the plugin use "javadoc" or "javadoc.exe" respectively from this
directory. |
javadocVersion | String |
2.3 |
Version of the Javadoc Tool executable to use, ex. "1.3", "1.5". |
keywords | boolean |
2.1 |
Adds HTML meta keyword tags to the generated file for each class.
See keywords . Since Java 1.4.2 . Since Java 5.0 . Default value is: false . |
links | ArrayList |
2.3 |
Creates links to existing javadoc-generated documentation of
external referenced classes. See link . |
linksource | boolean |
2.3 |
Creates an HTML version of each source file (with line numbers) and
adds links to them from the standard HTML documentation. See linksource . Since Java 1.4 . Default value is: false . |
localRepository | ArtifactRepository |
2.3 |
The local repository where the artifacts are located. |
locale | String |
2.3 |
Specifies the locale that javadoc uses when generating
documentation. See locale . |
maxmemory | String |
2.3 |
Specifies the maximum Java heap size to be used when launching the
Javadoc tool. JVMs refer to this property as the -Xmx
parameter. Example: '512' or '512m'. The memory unit depends on the
JVM used. The units supported could be: k ,
kb , m , mb , g ,
gb , t , tb . If no unit
specified, the default unit is m . |
minmemory | String |
2.3 |
Specifies the minimum Java heap size to be used when launching the
Javadoc tool. JVMs refer to this property as the -Xms
parameter. Example: '512' or '512m'. The memory unit depends on the
JVM used. The units supported could be: k ,
kb , m , mb , g ,
gb , t , tb . If no unit
specified, the default unit is m . |
name | String |
2.1 |
The name of the Javadoc report. |
nocomment | boolean |
2.3 |
Suppress the entire comment body, including the main description
and all tags, generating only declarations. See nocomment . Since Java 1.4 . Default value is: false . |
nodeprecated | boolean |
2.3 |
Prevents the generation of any deprecated API at all in the
documentation. See nodeprecated . Default value is: false . |
nodeprecatedlist | boolean |
2.3 |
Prevents the generation of the file containing the list of
deprecated APIs (deprecated-list.html) and the link in the
navigation bar to that page. See nodeprecatedlist . Default value is: false . |
nohelp | boolean |
2.3 |
Omits the HELP link in the navigation bars at the top and bottom of
each page of output. Note : could be in conflict with <helpfile/>. See nohelp . Default value is: false . |
noindex | boolean |
2.3 |
Omits the index from the generated docs. Note : could be in conflict with <splitindex/>. See noindex . Default value is: false . |
nonavbar | boolean |
2.3 |
Omits the navigation bar from the generated docs. See nonavbar . Default value is: false . |
nooverview | boolean |
2.4 |
Omits the entire overview page from the generated docs. Note : could be in conflict with <overview/>. Standard Doclet undocumented option. Default value is: false . |
noqualifier | String |
2.3 |
Omits qualifying package name from ahead of class names in output.
See noqualifier . Since Java 1.4 . |
nosince | boolean |
2.3 |
Omits from the generated docs the "Since" sections associated with
the since tags. See nosince . Default value is: false . |
notimestamp | boolean |
2.1 |
Suppresses the timestamp, which is hidden in an HTML comment in the
generated HTML near the top of each page. See notimestamp . Since Java 5.0 . Default value is: false . |
notree | boolean |
2.3 |
Omits the class/interface hierarchy pages from the generated docs.
See notree . Default value is: false . |
offlineLinks | OfflineLink[] |
2.3 |
This option is a variation of -link; they both create links to
javadoc-generated documentation for external referenced classes.
See linkoffline . Example: <offlineLinks> <offlineLink> <url>http://java.sun.com/j2se/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks> See Javadoc . |
old | boolean |
2.3 |
This option creates documentation with the appearance and
functionality of documentation generated by Javadoc 1.1. See 1.1 . Default value is: false . |
overview | File |
2.3 |
Specifies that javadoc should retrieve the text for the overview
documentation from the "source" file specified by path/filename and
place it on the Overview page (overview-summary.html). Note : could be in conflict with <nooverview/>. See overview . Default value is: ${basedir}/src/main/javadoc/overview.html . |
packagesheader | String |
2.1 |
Specify the text for upper left frame. Since Java 1.4.2 . |
proxyHost | String |
2.3 |
Deprecated. {0}. since 2.4. Instead of, configure an active proxy host in
settings.xml .Default value is: ${settings.activeProxy.host} . |
proxyPort | int |
2.3 |
Deprecated. {0}. since 2.4. Instead of, configure an active proxy port in
settings.xml .Default value is: ${settings.activeProxy.port} . |
quiet | boolean |
2.3 |
Shuts off non-error and non-warning messages, leaving only the
warnings and errors appear, making them easier to view. Note: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350 ). See quiet . Since Java 5.0. Default value is: false . |
remoteRepositories | List |
2.3 |
The remote repositories where artifacts are located. |
resourcesArtifacts | ResourcesArtifact[] |
2.5 |
A list of artifacts containing resources which should be copied
into the Javadoc output directory (like stylesheets, icons, etc.).
Example: <resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts> See Javadoc . |
serialwarn | boolean |
2.3 |
Generates compile-time warnings for missing serial tags. See serialwarn Default value is: false . |
show | String |
2.3 |
Specifies the access level for classes and members to show in the
Javadocs. Possible values are:
Default value is: protected . |
skip | boolean |
2.5 |
Specifies whether the Javadoc generation should be skipped. Default value is: false . |
source | String |
2.3 |
Necessary to enable javadoc to handle assertions present in J2SE v
1.4 source code. See source . Since Java 1.4 . |
sourcepath | String |
2.3 |
Specifies the source paths where the subpackages are located. The
paths are separated with a colon (: ) on Solaris and a
semi-colon (; ) on Windows. See sourcepath . |
sourcetab | int |
2.1 |
Specify the number of spaces each tab takes up in the source. If no
tab is used in source, the default space is used. Note: was linksourcetab in Java 1.4.2 (refer to bug ID
4788919
).
Since 1.4.2 . Since Java 5.0. |
splitindex | boolean |
2.3 |
Splits the index file into multiple files, alphabetically, one file
per letter, plus a file for any index entries that start with
non-alphabetical characters. Note : could be in conflict with <noindex/>. See splitindex . Default value is: false . |
stylesheet | String |
2.3 |
Specifies whether the stylesheet to be used is the maven javadoc
stylesheet or java's default stylesheet when a
stylesheetfile
parameter is not specified. Possible values:
"maven" or "java". Default value is: java . |
stylesheetfile | String |
2.3 |
Specifies the path of an alternate HTML stylesheet file. See stylesheetfile . |
subpackages | String |
2.3 |
Specifies the package directory where javadoc will be executed.
Multiple packages can be separated by colons (: ).
See subpackages . Since Java 1.4 . |
taglet | String |
2.3 |
Specifies the class file that starts the taglet used in generating
the documentation for that tag. See taglet . Since Java 1.4 . |
tagletArtifact | TagletArtifact |
2.1 |
Specifies the Taglet artifact containing the taglet class files
(.class). See tagletpath . Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> See Javadoc . |
tagletArtifacts | TagletArtifact[] |
2.5 |
Specifies several Taglet artifacts containing the taglet class
files (.class). These taglets class names will be auto-detect and
so no need to specify them. See taglet . See tagletpath . Example: <tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts> See Javadoc . |
tagletpath | String |
2.3 |
Specifies the search paths for finding taglet class files (.class).
The tagletPath can contain multiple paths by separating them with a
colon (: ) on Solaris and a semi-colon (; )
on Windows. See tagletpath . Since Java 1.4 . |
taglets | Taglet[] |
2.1 |
Enables the Javadoc tool to interpret multiple taglets. See taglet . See tagletpath . Example: <taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets> See Javadoc . |
tags | Tag[] |
2.3 |
Enables the Javadoc tool to interpret a simple, one-argument custom
block tag tagname in doc comments. See tag . Since Java 1.4 . Example: <tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags> See Javadoc . |
testDescription | String |
2.5 |
The description of the Test Javadoc report. |
testDoctitle | String |
2.5 |
Specifies the Test title to be placed near the top of the overview
summary file. See doctitle . Default value is: ${project.name} ${project.version} Test API . |
testJavadocDirectory | File |
2.5 |
Specifies the Test Javadoc resources directory to be included in
the Javadoc (i.e. package.html, images...). |
testName | String |
2.5 |
The name of the Test Javadoc report. |
testOverview | File |
2.5 |
Specifies that Javadoc should retrieve the text for the Test
overview documentation from the "source" file specified by
path/filename and place it on the Overview page
(overview-summary.html). See overview . Default value is: ${basedir}/src/test/javadoc/overview.html . |
testWindowtitle | String |
2.5 |
Specifies the Test title to be placed in the HTML title tag. See windowtitle . Default value is: ${project.name} ${project.version} Test API . |
top | String |
2.4 |
Specifies the top text to be placed at the top of each output file.
See 6227616 . Since Java 6.0 |
use | boolean |
2.3 |
Includes one "Use" page for each documented class and package.
See use . Default value is: true . |
useStandardDocletOptions | boolean |
2.5 |
Specifies to use the
options provided by the Standard Doclet
for a custom doclet.
Example: <docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions> Default value is: true . |
verbose | boolean |
2.3 |
Provides more detailed messages while javadoc is running. See verbose . Default value is: false . |
version | boolean |
2.3 |
Includes the version text in the generated docs. See version . Default value is: true . |
windowtitle | String |
2.3 |
Specifies the title to be placed in the HTML title tag. See windowtitle . Default value is: ${project.name} ${project.version} API . |
<additionalJOption>-J-Xss128m</additionalJOption>See Jflag .
java.lang.String
2.3
No
${additionalJOption}
java.lang.String
2.3
No
${additionalparam}
javadoc:aggregate
and
javadoc:test-aggregate
instead.boolean
2.3
No
${aggregate}
false
author :
boolean
2.3
No
${author}
true
java.lang.String
2.5
No
${bootclasspath}
<bootclasspathArtifacts> <bootclasspathArtifact> <groupId>my-groupId</groupId> <artifactId>my-artifactId</artifactId> <version>my-version</version> </bootclasspathArtifact> </bootclasspathArtifacts>
org.apache.maven.plugin.javadoc.options.BootclasspathArtifact[]
2.5
No
${bootclasspathArtifacts}
bottom :
<![CDATA[Copyright 2005, <a
href="http://www.mycompany.com">MyCompany,
Inc.<a>]]>
java.lang.String
2.3
No
${bottom}
Copyright � {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.
boolean
2.3
No
${breakiterator}
false
charset :
docencoding
parameter. java.lang.String
2.3
No
${charset}
debug :
boolean
2.1
No
${debug}
false
java.lang.String
2.1
No
${description}
destDir :
java.lang.String
2.3
No
${destDir}
testapidocs
UTF-8
.
java.lang.String
2.3
No
${docencoding}
${project.reporting.outputEncoding}
boolean
2.3
No
${docfilessubdirs}
false
doclet :
java.lang.String
2.3
No
${doclet}
<docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact>
org.apache.maven.plugin.javadoc.options.DocletArtifact
2.3
No
${docletArtifact}
<docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts>
org.apache.maven.plugin.javadoc.options.DocletArtifact[]
2.1
No
${docletArtifacts}
:
) on Solaris and a semi-colon (;
)
on Windows. java.lang.String
2.3
No
${docletPath}
doctitle :
java.lang.String
2.3
No
${doctitle}
${project.name} ${project.version} API
encoding :
file.encoding
system property. ISO-8859-1
to ensure reproducing build, but this was
reverted in 2.5. java.lang.String
2.3
No
${encoding}
${project.build.sourceEncoding}
:
). java.lang.String
2.3
No
${excludePackageNames}
:
). java.lang.String
2.3
No
${excludedocfilessubdir}
extdirs :
:
) on Solaris and
a semi-colon (;
) on Windows. java.lang.String
2.3
No
${extdirs}
boolean
2.5
No
${maven.javadoc.failOnError}
true
footer :
java.lang.String
2.3
No
${footer}
groups :
*
) meaning "match any characters".
Multiple patterns can be included in a group by separating them
with colons (:
). <groups> <group> <title>Core Packages</title> <packages>org.apache.core</packages> </group> </groups>
org.apache.maven.plugin.javadoc.options.Group[]
2.3
No
${groups}
header :
java.lang.String
2.3
No
${header}
helpfile :
java.lang.String
2.3
No
${helpfile}
docfilessubdirs
parameter. java.io.File
2.1
No
${basedir}/src/main/javadoc
java.lang.String
2.3
No
${javadocExecutable}
java.lang.String
2.3
No
${javadocVersion}
keywords :
boolean
2.1
No
${keywords}
false
links :
java.util.ArrayList
2.3
No
${links}
boolean
2.3
No
${linksource}
false
org.apache.maven.artifact.repository.ArtifactRepository
2.3
No
${localRepository}
locale :
java.lang.String
2.3
No
${locale}
-Xmx
parameter. Example: '512' or '512m'. The memory unit depends on the
JVM used. The units supported could be: k
,
kb
, m
, mb
, g
,
gb
, t
, tb
. If no unit
specified, the default unit is m
.java.lang.String
2.3
No
${maxmemory}
-Xms
parameter. Example: '512' or '512m'. The memory unit depends on the
JVM used. The units supported could be: k
,
kb
, m
, mb
, g
,
gb
, t
, tb
. If no unit
specified, the default unit is m
.java.lang.String
2.3
No
${minmemory}
name :
java.lang.String
2.1
No
${name}
boolean
2.3
No
${nocomment}
false
boolean
2.3
No
${nodeprecated}
false
boolean
2.3
No
${nodeprecatedlist}
false
nohelp :
boolean
2.3
No
${nohelp}
false
noindex :
boolean
2.3
No
${noindex}
false
nonavbar :
boolean
2.3
No
${nonavbar}
false
boolean
2.4
No
${nooverview}
false
java.lang.String
2.3
No
${noqualifier}
nosince :
boolean
2.3
No
${nosince}
false
boolean
2.1
No
${notimestamp}
false
notree :
boolean
2.3
No
${notree}
false
<offlineLinks> <offlineLink> <url>http://java.sun.com/j2se/1.5.0/docs/api/</url> <location>../javadoc/jdk-5.0/</location> </offlineLink> </offlineLinks>
org.apache.maven.plugin.javadoc.options.OfflineLink[]
2.3
No
${offlineLinks}
old :
boolean
2.3
No
${old}
false
java.io.File
2.3
Yes
${destDir}
${project.build.directory}/apidocs
overview :
java.io.File
2.3
No
${overview}
${basedir}/src/main/javadoc/overview.html
java.lang.String
2.1
No
${packagesheader}
settings.xml
.-link
would pass through. It defaults to the proxy
host of the active proxy set in the settings.xml
,
otherwise it gets the proxy configuration set in the pom. java.lang.String
2.3
No
${proxyHost}
${settings.activeProxy.host}
settings.xml
.-link
would pass through. It defaults to the proxy
port of the active proxy set in the settings.xml
,
otherwise it gets the proxy configuration set in the pom. int
2.3
No
${proxyPort}
${settings.activeProxy.port}
quiet :
boolean
2.3
No
${quiet}
false
java.util.List
2.3
No
${project.remoteArtifactRepositories}
java.io.File
2.3
Yes
${project.reporting.outputDirectory}/testapidocs
<resourcesArtifacts> <resourcesArtifact> <groupId>external.group.id</groupId> <artifactId>external-resources</artifactId> <version>1.0</version> </resourcesArtifact> </resourcesArtifacts>
org.apache.maven.plugin.javadoc.options.ResourcesArtifact[]
2.5
No
${resourcesArtifacts}
boolean
2.3
No
${serialwarn}
false
show :
java.lang.String
2.3
No
${show}
protected
skip :
boolean
2.5
No
${maven.javadoc.skip}
false
source :
java.lang.String
2.3
No
${source}
:
) on Solaris and a
semi-colon (;
) on Windows. java.lang.String
2.3
No
${sourcepath}
linksourcetab
in Java 1.4.2 (refer to bug ID
4788919
).
int
2.1
No
${sourcetab}
boolean
2.3
No
${splitindex}
false
java.lang.String
2.3
No
${stylesheet}
java
java.lang.String
2.3
No
${stylesheetfile}
:
).
java.lang.String
2.3
No
${subpackages}
taglet :
java.lang.String
2.3
No
${taglet}
<taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> </taglet> <taglet> <tagletClass>package.to.AnotherTagletClass</tagletClass> </taglet> ... </taglets> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact>
org.apache.maven.plugin.javadoc.options.TagletArtifact
2.1
No
${tagletArtifact}
<tagletArtifacts> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> ... </tagletArtifacts>
org.apache.maven.plugin.javadoc.options.TagletArtifact[]
2.5
No
${tagletArtifacts}
:
) on Solaris and a semi-colon (;
)
on Windows. java.lang.String
2.3
No
${tagletpath}
taglets :
<taglets> <taglet> <tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass> <!--<tagletpath>/home/taglets</tagletpath>--> <tagletArtifact> <groupId>group-Taglet</groupId> <artifactId>artifact-Taglet</artifactId> <version>version-Taglet</version> </tagletArtifact> </taglet> </taglets>
org.apache.maven.plugin.javadoc.options.Taglet[]
2.1
No
${taglets}
tags :
<tags> <tag> <name>todo</name> <placement>a</placement> <head>To Do:</head> </tag> </tags>
org.apache.maven.plugin.javadoc.options.Tag[]
2.3
No
${tags}
java.lang.String
2.5
No
${testDescription}
java.lang.String
2.5
No
${testDoctitle}
${project.name} ${project.version} Test API
java.io.File
2.5
No
${basedir}/src/test/javadoc
testName :
java.lang.String
2.5
No
${testName}
java.io.File
2.5
No
${testOverview}
${basedir}/src/test/javadoc/overview.html
java.lang.String
2.5
No
${testWindowtitle}
${project.name} ${project.version} Test API
top :
java.lang.String
2.4
No
${top}
use :
boolean
2.3
No
${use}
true
<docletArtifacts> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </docletArtifacts> <useStandardDocletOptions>true</useStandardDocletOptions>
boolean
2.5
No
${useStandardDocletOptions}
true
verbose :
boolean
2.3
No
${verbose}
false
version :
boolean
2.3
No
${version}
true
java.lang.String
2.3
No
${windowtitle}
${project.name} ${project.version} API