|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.plugin.javadoc.options.JavadocOptions
public class JavadocOptions
Root class to contain all javadoc configuration options for inclusion in javadoc bundle archives.
Constructor Summary | |
---|---|
JavadocOptions()
|
Method Summary | |
---|---|
void |
addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method addBootclasspathArtifact. |
void |
addDocletArtifact(DocletArtifact docletArtifact)
Method addDocletArtifact. |
void |
addExcludePackageName(String string)
Method addExcludePackageName. |
void |
addGroup(Group group)
Method addGroup. |
void |
addLink(String string)
Method addLink. |
void |
addOfflineLink(OfflineLink offlineLink)
Method addOfflineLink. |
void |
addResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method addResourcesArtifact. |
void |
addTag(Tag tag)
Method addTag. |
void |
addTaglet(Taglet taglet)
Method addTaglet. |
void |
addTagletArtifact(TagletArtifact tagletArtifact)
Method addTagletArtifact. |
List<BootclasspathArtifact> |
getBootclasspathArtifacts()
Method getBootclasspathArtifacts. |
List<DocletArtifact> |
getDocletArtifacts()
Method getDocletArtifacts. |
String |
getExcludedDocfilesSubdirs()
Get list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories. |
List<String> |
getExcludePackageNames()
Method getExcludePackageNames. |
List<Group> |
getGroups()
Method getGroups. |
String |
getJavadocResourcesDirectory()
Get path relative to project basedir where javadoc resources were located. |
List<String> |
getLinks()
Method getLinks. |
String |
getModelEncoding()
Get the modelEncoding field. |
List<OfflineLink> |
getOfflineLinks()
Method getOfflineLinks. |
List<ResourcesArtifact> |
getResourcesArtifacts()
Method getResourcesArtifacts. |
List<TagletArtifact> |
getTagletArtifacts()
Method getTagletArtifacts. |
List<Taglet> |
getTaglets()
Method getTaglets. |
List<Tag> |
getTags()
Method getTags. |
boolean |
isDocfilesSubdirsUsed()
Get enables deep copying of the '**/doc-files' directories and the specific 'resources' directory. |
void |
removeBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method removeBootclasspathArtifact. |
void |
removeDocletArtifact(DocletArtifact docletArtifact)
Method removeDocletArtifact. |
void |
removeExcludePackageName(String string)
Method removeExcludePackageName. |
void |
removeGroup(Group group)
Method removeGroup. |
void |
removeLink(String string)
Method removeLink. |
void |
removeOfflineLink(OfflineLink offlineLink)
Method removeOfflineLink. |
void |
removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method removeResourcesArtifact. |
void |
removeTag(Tag tag)
Method removeTag. |
void |
removeTaglet(Taglet taglet)
Method removeTaglet. |
void |
removeTagletArtifact(TagletArtifact tagletArtifact)
Method removeTagletArtifact. |
void |
setBootclasspathArtifacts(List<BootclasspathArtifact> bootclasspathArtifacts)
Set a list of BootclasspathArtifact parameters. |
void |
setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
Set enables deep copying of the '**/doc-files' directories and the specific 'resources' directory. |
void |
setDocletArtifacts(List<DocletArtifact> docletArtifacts)
Set a list of DocletArtifact parameters. |
void |
setExcludedDocfilesSubdirs(String excludedDocfilesSubdirs)
Set list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories. |
void |
setExcludePackageNames(List<String> excludePackageNames)
Set list of subpackage patterns to exclude from javadoc generation. |
void |
setGroups(List<Group> groups)
Set a list of Group parameters. |
void |
setJavadocResourcesDirectory(String javadocResourcesDirectory)
Set path relative to project basedir where javadoc resources were located. |
void |
setLinks(List<String> links)
Set list of URLs to javadocs for external classes. |
void |
setModelEncoding(String modelEncoding)
Set the modelEncoding field. |
void |
setOfflineLinks(List<OfflineLink> offlineLinks)
Set a list of OfflineLink parameters. |
void |
setResourcesArtifacts(List<ResourcesArtifact> resourcesArtifacts)
Set a list of ResourcesArtifact parameters. |
void |
setTagletArtifacts(List<TagletArtifact> tagletArtifacts)
Set a list of TagletArtifact parameters. |
void |
setTaglets(List<Taglet> taglets)
Set a list of Taglet parameters. |
void |
setTags(List<Tag> tags)
Set a list of Tag parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavadocOptions()
Method Detail |
---|
public void addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
bootclasspathArtifact
- public void addDocletArtifact(DocletArtifact docletArtifact)
docletArtifact
- public void addExcludePackageName(String string)
string
- public void addGroup(Group group)
group
- public void addLink(String string)
string
- public void addOfflineLink(OfflineLink offlineLink)
offlineLink
- public void addResourcesArtifact(ResourcesArtifact resourcesArtifact)
resourcesArtifact
- public void addTag(Tag tag)
tag
- public void addTaglet(Taglet taglet)
taglet
- public void addTagletArtifact(TagletArtifact tagletArtifact)
tagletArtifact
- public List<BootclasspathArtifact> getBootclasspathArtifacts()
public List<DocletArtifact> getDocletArtifacts()
public List<String> getExcludePackageNames()
public String getExcludedDocfilesSubdirs()
public List<Group> getGroups()
public String getJavadocResourcesDirectory()
public List<String> getLinks()
public String getModelEncoding()
public List<OfflineLink> getOfflineLinks()
public List<ResourcesArtifact> getResourcesArtifacts()
public List<TagletArtifact> getTagletArtifacts()
public List<Taglet> getTaglets()
public List<Tag> getTags()
public boolean isDocfilesSubdirsUsed()
public void removeBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
bootclasspathArtifact
- public void removeDocletArtifact(DocletArtifact docletArtifact)
docletArtifact
- public void removeExcludePackageName(String string)
string
- public void removeGroup(Group group)
group
- public void removeLink(String string)
string
- public void removeOfflineLink(OfflineLink offlineLink)
offlineLink
- public void removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
resourcesArtifact
- public void removeTag(Tag tag)
tag
- public void removeTaglet(Taglet taglet)
taglet
- public void removeTagletArtifact(TagletArtifact tagletArtifact)
tagletArtifact
- public void setBootclasspathArtifacts(List<BootclasspathArtifact> bootclasspathArtifacts)
bootclasspathArtifacts
- public void setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
docfilesSubdirsUsed
- public void setDocletArtifacts(List<DocletArtifact> docletArtifacts)
docletArtifacts
- public void setExcludePackageNames(List<String> excludePackageNames)
excludePackageNames
- public void setExcludedDocfilesSubdirs(String excludedDocfilesSubdirs)
excludedDocfilesSubdirs
- public void setGroups(List<Group> groups)
groups
- public void setJavadocResourcesDirectory(String javadocResourcesDirectory)
javadocResourcesDirectory
- public void setLinks(List<String> links)
links
- public void setModelEncoding(String modelEncoding)
modelEncoding
- public void setOfflineLinks(List<OfflineLink> offlineLinks)
offlineLinks
- public void setResourcesArtifacts(List<ResourcesArtifact> resourcesArtifacts)
resourcesArtifacts
- public void setTagletArtifacts(List<TagletArtifact> tagletArtifacts)
tagletArtifacts
- public void setTaglets(List<Taglet> taglets)
taglets
- public void setTags(List<Tag> tags)
tags
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |