Package org.apache.tools.ant.taskdefs
Class Javadoc
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Javadoc
- All Implemented Interfaces:
java.lang.Cloneable
public class Javadoc extends Task
Generates Javadoc documentation for a collection
of source code.
Current known limitations are:
- patterns must be of the form "xxx.*", every other pattern doesn't work.
- there is no control on arguments sanity since they are left to the Javadoc implementation.
If no doclet is set, then the version and
author are by default "yes".
Note: This task is run on another VM because the Javadoc code calls
System.exit() which would break Ant functionality.
- Since:
- Ant 1.1
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classJavadoc.AccessTypeEnumeratedAttribute implementation supporting the Javadoc scoping values.classJavadoc.DocletInfoThis class stores info about doclets.classJavadoc.DocletParamInner class used to manage doclet parameters.static classJavadoc.ExtensionInfoA project aware class used for Javadoc extensions which take a name and a path such as doclet and taglet arguments.classJavadoc.GroupArgumentA class corresponding to the group nested element.static classJavadoc.HtmlAn HTML element in the Javadoc.classJavadoc.LinkArgumentRepresents a link triplet (href, whether link is offline, location of the package list if off line)static classJavadoc.PackageNameUsed to track info about the packages to be javadoc'dclassJavadoc.ResourceCollectionContainerHolds a collection of ResourceCollections.static classJavadoc.SourceFileThis class is used to manage the source files to be processed.classJavadoc.TagArgumentClass representing a -tag argument. -
Field Summary
-
Constructor Summary
Constructors Constructor Description Javadoc() -
Method Summary
Modifier and Type Method Description voidaddBottom(Javadoc.Html text)Set the text to be placed at the bottom of each output file.voidaddDoctitle(Javadoc.Html text)Add a document title to use for the overview page.voidaddExcludePackage(Javadoc.PackageName pn)Add a package to be excluded from the Javadoc run.voidaddFileset(FileSet fs)Adds a fileset.voidaddFooter(Javadoc.Html text)Set the footer text to be placed at the bottom of each output file.voidaddHeader(Javadoc.Html text)Set the header text to be placed at the top of each output file.voidaddModule(Javadoc.PackageName mn)Add a single module to be processed.voidaddPackage(Javadoc.PackageName pn)Add a single package to be processed.voidaddPackageset(DirSet packageSet)Adds a packageset.voidaddSource(Javadoc.SourceFile sf)Add a single source file.voidaddTaglet(Javadoc.ExtensionInfo tagletInfo)Add a tagletCommandline.ArgumentcreateArg()Adds a command-line argument.PathcreateBootclasspath()Create a Path to be configured with the boot classpathPathcreateClasspath()Create a Path to be configured with the classpath to useJavadoc.DocletInfocreateDoclet()Create a doclet to be used in the documentation generation.Javadoc.GroupArgumentcreateGroup()Separates packages on the overview page into whatever groups you specify, one group per table.Javadoc.LinkArgumentcreateLink()Create link to Javadoc output at the given URL.PathcreateModulePath()Create a path to be configured with the locations of the module files.PathcreateModuleSourcePath()Create a path to be configured with the locations of the module source files.Javadoc.ResourceCollectionContainercreateSourceFiles()Adds a container for resource collections.PathcreateSourcepath()Create a path to be configured with the locations of the source files.Javadoc.TagArgumentcreateTag()Creates and adds a -tag argument.voidexecute()Execute the task.protected java.lang.Stringexpand(java.lang.String content)Convenience method to expand properties.voidsetAccess(Javadoc.AccessType at)Set the scope to be processed.voidsetAdditionalparam(java.lang.String add)Set an additional parameter on the command linevoidsetAuthor(boolean b)Include the author tag in the generated documentation.voidsetBootclasspath(Path path)Set the boot classpath to use.voidsetBootClasspathRef(Reference r)Adds a reference to a CLASSPATH defined elsewhere.voidsetBottom(java.lang.String bottom)Set the text to be placed at the bottom of each output file.voidsetBreakiterator(boolean b)Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version.voidsetCharset(java.lang.String src)Charset for cross-platform viewing of generated documentation.voidsetClasspath(Path path)Set the classpath to be used for this Javadoc run.voidsetClasspathRef(Reference r)Adds a reference to a CLASSPATH defined elsewhere.voidsetDefaultexcludes(boolean useDefaultExcludes)Sets whether default exclusions should be used or not.voidsetDestdir(java.io.File dir)Set the directory where the Javadoc output will be generated.voidsetDocencoding(java.lang.String enc)Output file encoding name.voidsetDocFilesSubDirs(boolean b)Enables deep-copying ofdoc-filesdirectories.voidsetDoclet(java.lang.String docletName)Set the class that starts the doclet used in generating the documentation.voidsetDocletPath(Path docletPath)Set the classpath used to find the doclet class.voidsetDocletPathRef(Reference r)Set the classpath used to find the doclet class by reference.voidsetDoctitle(java.lang.String doctitle)Set the title of the generated overview page.voidsetEncoding(java.lang.String enc)Set the encoding name of the source files,voidsetExcludeDocFilesSubDir(java.lang.String s)Colon-separated list ofdoc-filessubdirectories to skip ifdocFilesSubDirs is true.voidsetExcludePackageNames(java.lang.String packages)Set the list of packages to be excluded.voidsetExecutable(java.lang.String executable)Sets the actual executable command to invoke, instead of the binaryjavadocfound in Ant's JDK.voidsetExtdirs(java.lang.String path)Deprecated.since 1.5.x.voidsetExtdirs(Path path)Set the location of the extensions directories.voidsetFailonerror(boolean b)Should the build process fail if Javadoc fails (as indicated by a non zero return code)?voidsetFailonwarning(boolean b)Should the build process fail if Javadoc warns (as indicated by the word "warning" on stdout)?voidsetFooter(java.lang.String footer)Set the footer text to be placed at the bottom of each output file.voidsetGroup(java.lang.String src)Group specified packages together in overview page.voidsetHeader(java.lang.String header)Set the header text to be placed at the top of each output file.voidsetHelpfile(java.io.File f)Specifies the HTML help file to use.voidsetIncludeNoSourcePackages(boolean b)If set to true, Ant will also accept packages that only hold package.html files but no Java sources.voidsetLink(java.lang.String src)Create links to Javadoc output at the given URL.voidsetLinkoffline(java.lang.String src)Link to docs at "url" using package list at "url2" - separate the URLs by using a space character.voidsetLinksource(boolean b)Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version.voidsetLocale(java.lang.String locale)Set the local to use in documentation generation.voidsetMaxmemory(java.lang.String max)Set the maximum memory to be used by the javadoc processvoidsetModulenames(java.lang.String modules)Set the module names to be processed.voidsetModulePath(Path mp)Specify where to find modulesvoidsetModulePathref(Reference r)Adds a reference to a path defined elsewhere that defines the module path.voidsetModuleSourcePath(Path mp)Specify where to find sources for modulesvoidsetModuleSourcePathref(Reference r)Adds a reference to a path defined elsewhere that defines the module source path.voidsetNodeprecated(boolean b)Control deprecation informationvoidsetNodeprecatedlist(boolean b)Control deprecated list generationvoidsetNohelp(boolean b)Control generation of help link.voidsetNoindex(boolean b)Control generation of index.voidsetNonavbar(boolean b)Control generation of the navigation bar.voidsetNoqualifier(java.lang.String noqualifier)Enables the -noqualifier switch, will be ignored if Javadoc is not the 1.4 version.voidsetNotree(boolean b)Control class tree generation.voidsetOld(boolean b)Indicate whether Javadoc should produce old style (JDK 1.1) documentation.voidsetOverview(java.io.File f)Specify the file containing the overview to be included in the generated documentation.voidsetPackage(boolean b)Indicate whether only package, protected and public classes and members are to be included in the scope processedvoidsetPackageList(java.lang.String src)The name of a file containing the packages to process.voidsetPackagenames(java.lang.String packages)Set the package names to be processed.voidsetPostProcessGeneratedJavadocs(boolean b)Whether to post-process the generated javadocs in order to mitigate CVE-2013-1571.voidsetPrivate(boolean b)Indicate whether all classes and members are to be included in the scope processedvoidsetProtected(boolean b)Indicate whether only protected and public classes and members are to be included in the scope processedvoidsetPublic(boolean b)Indicate whether only public classes and members are to be included in the scope processedvoidsetSerialwarn(boolean b)Control warnings about serial tag.voidsetSource(java.lang.String source)Enables the -source switch, will be ignored if Javadoc is not the 1.4 version.voidsetSourcefiles(java.lang.String src)Set the list of source files to process.voidsetSourcepath(Path src)Specify where to find source filevoidsetSourcepathRef(Reference r)Adds a reference to a CLASSPATH defined elsewhere.voidsetSplitindex(boolean b)Generate a split indexvoidsetStylesheetfile(java.io.File f)Specifies the CSS stylesheet file to use.voidsetUse(boolean b)Generate the "use" page for each package.voidsetUseExternalFile(boolean b)Work around command line length limit by using an external file for the sourcefiles.voidsetVerbose(boolean b)Run javadoc in verbose modevoidsetVersion(boolean b)Include the version tag in the generated documentation.voidsetWindowtitle(java.lang.String title)Set the title to be placed in the HTML <title> tag of the generated documentation.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
Javadoc
public Javadoc()
-
-
Method Details
-
setUseExternalFile
public void setUseExternalFile(boolean b)Work around command line length limit by using an external file for the sourcefiles.- Parameters:
b- true if an external file is to be used.
-
setDefaultexcludes
public void setDefaultexcludes(boolean useDefaultExcludes)Sets whether default exclusions should be used or not.- Parameters:
useDefaultExcludes- "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.
-
setMaxmemory
public void setMaxmemory(java.lang.String max)Set the maximum memory to be used by the javadoc process- Parameters:
max- a string indicating the maximum memory according to the JVM conventions (e.g. 128m is 128 Megabytes)
-
setAdditionalparam
public void setAdditionalparam(java.lang.String add)Set an additional parameter on the command line- Parameters:
add- the additional command line parameter for the javadoc task.
-
createArg
Adds a command-line argument.- Returns:
- a command-line argument to configure
- Since:
- Ant 1.6
-
setSourcepath
Specify where to find source file- Parameters:
src- a Path instance containing the various source directories.
-
createSourcepath
Create a path to be configured with the locations of the source files.- Returns:
- a new Path instance to be configured by the Ant core.
-
setSourcepathRef
Adds a reference to a CLASSPATH defined elsewhere.- Parameters:
r- the reference containing the source path definition.
-
setModulePath
Specify where to find modules- Parameters:
mp- a Path instance containing the modules.- Since:
- Ant 1.10.6
-
createModulePath
Create a path to be configured with the locations of the module files.- Returns:
- a new Path instance to be configured by the Ant core.
- Since:
- Ant 1.10.6
-
setModulePathref
Adds a reference to a path defined elsewhere that defines the module path.- Parameters:
r- the reference containing the module path definition.- Since:
- Ant 1.10.6
-
setModuleSourcePath
Specify where to find sources for modules- Parameters:
mp- a Path instance containing the sources for modules.- Since:
- Ant 1.10.6
-
createModuleSourcePath
Create a path to be configured with the locations of the module source files.- Returns:
- a new Path instance to be configured by the Ant core.
- Since:
- Ant 1.10.6
-
setModuleSourcePathref
Adds a reference to a path defined elsewhere that defines the module source path.- Parameters:
r- the reference containing the module source path definition.- Since:
- Ant 1.10.6
-
setDestdir
public void setDestdir(java.io.File dir)Set the directory where the Javadoc output will be generated.- Parameters:
dir- the destination directory.
-
setSourcefiles
public void setSourcefiles(java.lang.String src)Set the list of source files to process.- Parameters:
src- a comma separated list of source files.
-
addSource
Add a single source file.- Parameters:
sf- the source file to be processed.
-
setPackagenames
public void setPackagenames(java.lang.String packages)Set the package names to be processed.- Parameters:
packages- a comma separated list of packages specs (may be wildcarded).- See Also:
for wildcard information.
-
setModulenames
public void setModulenames(java.lang.String modules)Set the module names to be processed.- Parameters:
modules- a comma separated list of module names- Since:
- Ant 1.10.6
-
addPackage
Add a single package to be processed. If the package name ends with ".*" the Javadoc task will find and process all subpackages.- Parameters:
pn- the package name, possibly wildcarded.
-
addModule
Add a single module to be processed.- Parameters:
mn- the module name- Since:
- Ant 1.10.6
-
setExcludePackageNames
public void setExcludePackageNames(java.lang.String packages)Set the list of packages to be excluded.- Parameters:
packages- a comma separated list of packages to be excluded. This may not include wildcards.
-
addExcludePackage
Add a package to be excluded from the Javadoc run.- Parameters:
pn- the name of the package (wildcards are not permitted).
-
setOverview
public void setOverview(java.io.File f)Specify the file containing the overview to be included in the generated documentation.- Parameters:
f- the file containing the overview.
-
setPublic
public void setPublic(boolean b)Indicate whether only public classes and members are to be included in the scope processed- Parameters:
b- true if scope is to be public.
-
setProtected
public void setProtected(boolean b)Indicate whether only protected and public classes and members are to be included in the scope processed- Parameters:
b- true if scope is to be protected.
-
setPackage
public void setPackage(boolean b)Indicate whether only package, protected and public classes and members are to be included in the scope processed- Parameters:
b- true if scope is to be package level.
-
setPrivate
public void setPrivate(boolean b)Indicate whether all classes and members are to be included in the scope processed- Parameters:
b- true if scope is to be private level.
-
setAccess
Set the scope to be processed. This is an alternative to the use of the setPublic, setPrivate, etc methods. It gives better build file control over what scope is processed.- Parameters:
at- the scope to be processed.
-
setDoclet
public void setDoclet(java.lang.String docletName)Set the class that starts the doclet used in generating the documentation.- Parameters:
docletName- the name of the doclet class.
-
setDocletPath
Set the classpath used to find the doclet class.- Parameters:
docletPath- the doclet classpath.
-
setDocletPathRef
Set the classpath used to find the doclet class by reference.- Parameters:
r- the reference to the Path instance to use as the doclet classpath.
-
createDoclet
Create a doclet to be used in the documentation generation.- Returns:
- a new DocletInfo instance to be configured.
-
addTaglet
Add a taglet- Parameters:
tagletInfo- information about the taglet.
-
setOld
public void setOld(boolean b)Indicate whether Javadoc should produce old style (JDK 1.1) documentation. This is not supported by JDK 1.1 and has been phased out in JDK 1.4- Parameters:
b- if true attempt to generate old style documentation.
-
setClasspath
Set the classpath to be used for this Javadoc run.- Parameters:
path- an Ant Path object containing the compilation classpath.
-
createClasspath
Create a Path to be configured with the classpath to use- Returns:
- a new Path instance to be configured with the classpath.
-
setClasspathRef
Adds a reference to a CLASSPATH defined elsewhere.- Parameters:
r- the reference to an instance defining the classpath.
-
setBootclasspath
Set the boot classpath to use.- Parameters:
path- the boot classpath.
-
createBootclasspath
Create a Path to be configured with the boot classpath- Returns:
- a new Path instance to be configured with the boot classpath.
-
setBootClasspathRef
Adds a reference to a CLASSPATH defined elsewhere.- Parameters:
r- the reference to an instance defining the bootclasspath.
-
setExtdirs
@Deprecated public void setExtdirs(java.lang.String path)Deprecated.since 1.5.x. Use thesetExtdirs(Path)version.Set the location of the extensions directories.- Parameters:
path- the string version of the path.
-
setExtdirs
Set the location of the extensions directories.- Parameters:
path- a path containing the extension directories.
-
setVerbose
public void setVerbose(boolean b)Run javadoc in verbose mode- Parameters:
b- true if operation is to be verbose.
-
setLocale
public void setLocale(java.lang.String locale)Set the local to use in documentation generation.- Parameters:
locale- the locale to use.
-
setEncoding
public void setEncoding(java.lang.String enc)Set the encoding name of the source files,- Parameters:
enc- the name of the encoding for the source files.
-
setVersion
public void setVersion(boolean b)Include the version tag in the generated documentation.- Parameters:
b- true if the version tag should be included.
-
setUse
public void setUse(boolean b)Generate the "use" page for each package.- Parameters:
b- true if the use page should be generated.
-
setAuthor
public void setAuthor(boolean b)Include the author tag in the generated documentation.- Parameters:
b- true if the author tag should be included.
-
setSplitindex
public void setSplitindex(boolean b)Generate a split index- Parameters:
b- true if the index should be split into a file per letter.
-
setWindowtitle
public void setWindowtitle(java.lang.String title)Set the title to be placed in the HTML <title> tag of the generated documentation.- Parameters:
title- the window title to use.
-
setDoctitle
public void setDoctitle(java.lang.String doctitle)Set the title of the generated overview page.- Parameters:
doctitle- the Document title.
-
addDoctitle
Add a document title to use for the overview page.- Parameters:
text- the HTML element containing the document title.
-
setHeader
public void setHeader(java.lang.String header)Set the header text to be placed at the top of each output file.- Parameters:
header- the header text
-
addHeader
Set the header text to be placed at the top of each output file.- Parameters:
text- the header text
-
setFooter
public void setFooter(java.lang.String footer)Set the footer text to be placed at the bottom of each output file.- Parameters:
footer- the footer text.
-
addFooter
Set the footer text to be placed at the bottom of each output file.- Parameters:
text- the footer text.
-
setBottom
public void setBottom(java.lang.String bottom)Set the text to be placed at the bottom of each output file.- Parameters:
bottom- the bottom text.
-
addBottom
Set the text to be placed at the bottom of each output file.- Parameters:
text- the bottom text.
-
setLinkoffline
public void setLinkoffline(java.lang.String src)Link to docs at "url" using package list at "url2" - separate the URLs by using a space character.- Parameters:
src- the offline link specification (url and package list)
-
setGroup
public void setGroup(java.lang.String src)Group specified packages together in overview page.- Parameters:
src- the group packages - a command separated list of group specs, each one being a group name and package specification separated by a space.
-
setLink
public void setLink(java.lang.String src)Create links to Javadoc output at the given URL.- Parameters:
src- the URL to link to
-
setNodeprecated
public void setNodeprecated(boolean b)Control deprecation information- Parameters:
b- If true, do not include deprecated information.
-
setNodeprecatedlist
public void setNodeprecatedlist(boolean b)Control deprecated list generation- Parameters:
b- if true, do not generate deprecated list.
-
setNotree
public void setNotree(boolean b)Control class tree generation.- Parameters:
b- if true, do not generate class hierarchy.
-
setNoindex
public void setNoindex(boolean b)Control generation of index.- Parameters:
b- if true, do not generate index.
-
setNohelp
public void setNohelp(boolean b)Control generation of help link.- Parameters:
b- if true, do not generate help link
-
setNonavbar
public void setNonavbar(boolean b)Control generation of the navigation bar.- Parameters:
b- if true, do not generate navigation bar.
-
setSerialwarn
public void setSerialwarn(boolean b)Control warnings about serial tag.- Parameters:
b- if true, generate warning about the serial tag.
-
setStylesheetfile
public void setStylesheetfile(java.io.File f)Specifies the CSS stylesheet file to use.- Parameters:
f- the file with the CSS to use.
-
setHelpfile
public void setHelpfile(java.io.File f)Specifies the HTML help file to use.- Parameters:
f- the file containing help content.
-
setDocencoding
public void setDocencoding(java.lang.String enc)Output file encoding name.- Parameters:
enc- name of the encoding to use.
-
setPackageList
public void setPackageList(java.lang.String src)The name of a file containing the packages to process.- Parameters:
src- the file containing the package list.
-
createLink
Create link to Javadoc output at the given URL.- Returns:
- link argument to configure
-
createTag
Creates and adds a -tag argument. This is used to specify custom tags. This argument is only available for Javadoc 1.4, and will generate a verbose message (and then be ignored) when run on Java versions below 1.4.- Returns:
- tag argument to be configured
-
createGroup
Separates packages on the overview page into whatever groups you specify, one group per table.- Returns:
- a group argument to be configured
-
setCharset
public void setCharset(java.lang.String src)Charset for cross-platform viewing of generated documentation.- Parameters:
src- the name of the charset
-
setFailonerror
public void setFailonerror(boolean b)Should the build process fail if Javadoc fails (as indicated by a non zero return code)?Default is false.
- Parameters:
b- abooleanvalue
-
setFailonwarning
public void setFailonwarning(boolean b)Should the build process fail if Javadoc warns (as indicated by the word "warning" on stdout)?Default is false.
- Parameters:
b- abooleanvalue- Since:
- Ant 1.9.4
-
setSource
public void setSource(java.lang.String source)Enables the -source switch, will be ignored if Javadoc is not the 1.4 version.- Parameters:
source- aStringvalue- Since:
- Ant 1.5
-
setExecutable
public void setExecutable(java.lang.String executable)Sets the actual executable command to invoke, instead of the binaryjavadocfound in Ant's JDK.- Parameters:
executable- the command to invoke.- Since:
- Ant 1.6.3
-
addPackageset
Adds a packageset.All included directories will be translated into package names be converting the directory separator into dots.
- Parameters:
packageSet- a directory set- Since:
- 1.5
-
addFileset
Adds a fileset.All included files will be added as sourcefiles. The task will automatically add
includes="**/*.java"to the fileset.- Parameters:
fs- a file set- Since:
- 1.5
-
createSourceFiles
Adds a container for resource collections.All included files will be added as sourcefiles.
- Returns:
- the source files to configure.
- Since:
- 1.7
-
setLinksource
public void setLinksource(boolean b)Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version. Default is false- Parameters:
b- aStringvalue- Since:
- Ant 1.6
-
setBreakiterator
public void setBreakiterator(boolean b)Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version. Default is false- Parameters:
b- aStringvalue- Since:
- Ant 1.6
-
setNoqualifier
public void setNoqualifier(java.lang.String noqualifier)Enables the -noqualifier switch, will be ignored if Javadoc is not the 1.4 version.- Parameters:
noqualifier- the parameter to the -noqualifier switch- Since:
- Ant 1.6
-
setIncludeNoSourcePackages
public void setIncludeNoSourcePackages(boolean b)If set to true, Ant will also accept packages that only hold package.html files but no Java sources.- Parameters:
b- abooleanvalue.- Since:
- Ant 1.6.3
-
setDocFilesSubDirs
public void setDocFilesSubDirs(boolean b)Enables deep-copying ofdoc-filesdirectories.- Parameters:
b- boolean- Since:
- Ant 1.8.0
-
setExcludeDocFilesSubDir
public void setExcludeDocFilesSubDir(java.lang.String s)Colon-separated list ofdoc-filessubdirectories to skip ifdocFilesSubDirs is true.- Parameters:
s- String- Since:
- Ant 1.8.0
-
setPostProcessGeneratedJavadocs
public void setPostProcessGeneratedJavadocs(boolean b)Whether to post-process the generated javadocs in order to mitigate CVE-2013-1571.- Parameters:
b- boolean- Since:
- Ant 1.9.2
-
execute
Execute the task.- Overrides:
executein classTask- Throws:
BuildException- on error
-
expand
protected java.lang.String expand(java.lang.String content)Convenience method to expand properties.- Parameters:
content- the string to expand- Returns:
- the converted string
-