javadocoptions JavadocOptions package org.apache.maven.plugins.javadoc.options JavadocOptions 1.1.0+ Root class to contain all javadoc configuration options for inclusion in javadoc bundle archives. groups 1.1.0+ A list of Group parameters. false Group * tags 1.1.0+ A list of Tag parameters. false Tag * docletArtifacts 1.1.0+ A list of DocletArtifact parameters. false DocletArtifact * taglets 1.1.0+ A list of Taglet parameters. false Taglet * offlineLinks 1.1.0+ A list of OfflineLink parameters. false OfflineLink * tagletArtifacts 1.1.0+ A list of TagletArtifact parameters. false TagletArtifact * resourcesArtifacts 1.1.0+ A list of ResourcesArtifact parameters. false ResourcesArtifact * bootclasspathArtifacts 1.1.0+ A list of BootclasspathArtifact parameters. false BootclasspathArtifact * links 1.1.0+ List of URLs to javadocs for external classes. false String * excludePackageNames 1.1.0+ List of subpackage patterns to exclude from javadoc generation. false String * docfilesSubdirsUsed 1.1.0+ Enables deep copying of the '**/doc-files' directories and the specific 'resources' directory. false boolean excludedDocfilesSubdirs 1.1.0+ List of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories. false String javadocResourcesDirectory 1.1.0+ Path relative to project basedir where javadoc resources were located. This is mainly useful in multimodule builds where the reactor is still populated. false String 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 A doclet parameter as artifact. 1.0.0+ JavadocPathArtifact TagletArtifact A taglet parameter as artifact. 1.0.0+ JavadocPathArtifact ResourcesArtifact A artifact containing resources. 1.0.0+ JavadocPathArtifact BootclasspathArtifact A bootclasspath parameter as artifact. 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 OfflineLink An offline link parameter. 1.0.0+ url The url of the link. 1.0.0+ String true location The location of the link. 1.0.0+ String true