public class JavadocOptions extends Object implements Serializable
Constructor and Description |
---|
JavadocOptions() |
Modifier and Type | Method and Description |
---|---|
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 |
getBootclasspathArtifacts()
Method getBootclasspathArtifacts.
|
List |
getDocletArtifacts()
Method getDocletArtifacts.
|
String |
getExcludedDocfilesSubdirs()
Get list of exclusion patterns separated by ':' for deep
copying of the '**/doc-files' directories.
|
List |
getExcludePackageNames()
Method getExcludePackageNames.
|
List |
getGroups()
Method getGroups.
|
String |
getJavadocResourcesDirectory()
Get path relative to project basedir where javadoc resources
were located.
|
List |
getLinks()
Method getLinks.
|
String |
getModelEncoding()
Get the modelEncoding field.
|
List |
getOfflineLinks()
Method getOfflineLinks.
|
List |
getResourcesArtifacts()
Method getResourcesArtifacts.
|
List |
getTagletArtifacts()
Method getTagletArtifacts.
|
List |
getTaglets()
Method getTaglets.
|
List |
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 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 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 excludePackageNames)
Set list of subpackage patterns to exclude from javadoc
generation.
|
void |
setGroups(List 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 links)
Set list of URLs to javadocs for external classes.
|
void |
setModelEncoding(String modelEncoding)
Set the modelEncoding field.
|
void |
setOfflineLinks(List offlineLinks)
Set a list of OfflineLink parameters.
|
void |
setResourcesArtifacts(List resourcesArtifacts)
Set a list of ResourcesArtifact parameters.
|
void |
setTagletArtifacts(List tagletArtifacts)
Set a list of TagletArtifact parameters.
|
void |
setTaglets(List taglets)
Set a list of Taglet parameters.
|
void |
setTags(List tags)
Set a list of Tag parameters.
|
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 getBootclasspathArtifacts()
public List getDocletArtifacts()
public List getExcludePackageNames()
public String getExcludedDocfilesSubdirs()
public List getGroups()
public String getJavadocResourcesDirectory()
public List getLinks()
public String getModelEncoding()
public List getOfflineLinks()
public List getResourcesArtifacts()
public List getTagletArtifacts()
public List getTaglets()
public List 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 bootclasspathArtifacts)
bootclasspathArtifacts
- public void setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
docfilesSubdirsUsed
- public void setDocletArtifacts(List docletArtifacts)
docletArtifacts
- public void setExcludePackageNames(List excludePackageNames)
excludePackageNames
- public void setExcludedDocfilesSubdirs(String excludedDocfilesSubdirs)
excludedDocfilesSubdirs
- public void setGroups(List groups)
groups
- public void setJavadocResourcesDirectory(String javadocResourcesDirectory)
javadocResourcesDirectory
- public void setLinks(List links)
links
- public void setModelEncoding(String modelEncoding)
modelEncoding
- public void setOfflineLinks(List offlineLinks)
offlineLinks
- public void setResourcesArtifacts(List resourcesArtifacts)
resourcesArtifacts
- public void setTagletArtifacts(List tagletArtifacts)
tagletArtifacts
- public void setTaglets(List taglets)
taglets
- public void setTags(List tags)
tags
- Copyright © 2004-2015 The Apache Software Foundation. All Rights Reserved.