javadocoptions
JavadocOptions
package
org.apache.maven.plugin.javadoc.options
Group
A Group parameter.
1.0.0
title
Title can be any text, and can include white space. This text is placed in the table heading for the group.
1.0.0
String
true
packages
Packages can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (:).
1.0.0
String
true
Tag
A Tag parameter.
1.0.0
name
Name of the tag.
1.0.0
String
true
head
Head of the tag.
1.0.0
String
true
1.0.0
* X (disable tag)
* a (all)
* o (overview)
* p (packages)
* t (types, that is classes and interfaces)
* c (constructors)
* m (methods)
* f (fields)
*
*
* @param placement
* @throws IllegalArgumentException if not a valid combinaison of the letters
*/
public void setPlacement(String placement)
throws IllegalArgumentException
{
char[] chars = placement.toCharArray();
for ( int i = 0; i < chars.length; i++ )
{
switch ( chars[i] )
{
case 'X':
case 'a':
case 'o':
case 'p':
case 't':
case 'c':
case 'm':
case 'f':
break;
default:
throw new IllegalArgumentException( "Placement should be a combinaison of the letters 'Xaoptcmf'." );
}
}
this.placement = placement;
}
]]>
JavadocPathArtifact
An artifact object used by Javadoc path options like -docletpath or -tagletpath.
1.0.0
groupId
The id of the group of the artifact.
1.0.0
String
true
artifactId
The id of the artifact.
1.0.0
String
true
version
The version of the artifact.
1.0.0
String
true
DocletArtifact
1.0.0
JavadocPathArtifact
TagletArtifact
1.0.0
JavadocPathArtifact
Taglet
A Taglet parameter.
1.0.0
tagletClass
tagletClass is the fully-qualified name for the taglet class.
1.0.0
String
true
tagletpath
Specifies the search paths for finding taglet class files (.class).
1.0.0
String
true
tagletArtifact
Specifies the taglet artifact to be included in the tagletpath option for finding taglet class files (.class).
1.0.0
TagletArtifact