addBottom
public void addBottom(Javadoc.Html text)
Set the text to be placed at the bottom of each output file.
text
- the bottom text.
addDoctitle
public void addDoctitle(Javadoc.Html text)
Add a document title to use for the overview page.
text
- the HTML element containing the document title.
addExcludePackage
public void addExcludePackage(Javadoc.PackageName pn)
Add a package to be excluded from the javadoc run.
pn
- the name of the package (wildcards are not permitted).
addFileset
public void addFileset(FileSet fs)
Adds a fileset.
All included files will be added as sourcefiles. The task
will automatically add
includes="**/*.java"
to the
fileset.
- 1.5
addFooter
public void addFooter(Javadoc.Html text)
Set the footer text to be placed at the bottom of each output file.
text
- the footer text.
addHeader
public void addHeader(Javadoc.Html text)
Set the header text to be placed at the top of each output file.
text
- the header text
addPackage
public void addPackage(Javadoc.PackageName pn)
Add a single package to be processed.
If the package name ends with ".*" the Javadoc task
will find and process all subpackages.
pn
- the package name, possibly wildcarded.
addPackageset
public void addPackageset(DirSet packageSet)
Adds a packageset.
All included directories will be translated into package
names be converting the directory separator into dots.
- 1.5
addSource
public void addSource(Javadoc.SourceFile sf)
Add a single source file.
sf
- the source file to be processed.
addTaglet
public void addTaglet(Javadoc.ExtensionInfo tagletInfo)
Add a taglet
tagletInfo
- information about the taglet.
createBootclasspath
public Path createBootclasspath()
Create a Path to be configured with the boot classpath
- a new Path instance to be configured with the boot classpath.
createClasspath
public Path createClasspath()
Create a Path to be configured with the classpath to use
- a new Path instance to be configured with the classpath.
createDoclet
public Javadoc.DocletInfo createDoclet()
Create a doclet to be used in the documentation generation.
- a new DocletInfo instance to be configured.
createGroup
public Javadoc.GroupArgument createGroup()
Separates packages on the overview page into whatever
groups you specify, one group per table.
createLink
public Javadoc.LinkArgument createLink()
Create link to javadoc output at the given URL.
- link argument to configure
createSourcepath
public Path createSourcepath()
Create a path to be configured with the locations of the source
files.
- a new Path instance to be configured by the Ant core.
createTag
public Javadoc.TagArgument 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.
execute
public void execute()
throws BuildException
Called by the project to let the task do its work. This method may be
called more than once, if the task is invoked more than once.
For example,
if target1 and target2 both depend on target3, then running
"ant target1 target2" will run all tasks in target3 twice.
- execute in interface Task
BuildException
- if something goes wrong with the build
expand
protected String expand(String content)
Convenience method to expand properties.
setAccess
public void setAccess(Javadoc.AccessType at)
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.
at
- the scope to be processed.
setAdditionalparam
public void setAdditionalparam(String add)
Set an additional parameter on the command line
add
- the additional command line parameter for the javadoc task.
setAuthor
public void setAuthor(boolean b)
Include the author tag in the generated documentation.
b
- true if the author tag should be included.
setBootClasspathRef
public void setBootClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
r
- the reference to an instance defining the bootclasspath.
setBootclasspath
public void setBootclasspath(Path path)
Set the boot classpath to use.
path
- the boot classpath.
setBottom
public void setBottom(String bottom)
Set the text to be placed at the bottom of each output file.
bottom
- the bottom text.
setBreakiterator
public void setBreakiterator(boolean b)
Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false
- Ant 1.6
setCharset
public void setCharset(String src)
Charset for cross-platform viewing of generated documentation.
setClasspath
public void setClasspath(Path path)
Set the classpath to be used for this javadoc run.
path
- an Ant Path object containing the compilation
classpath.
setClasspathRef
public void setClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
r
- the reference to an instance defining the classpath.
setDefaultexcludes
public void setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not.
useDefaultExcludes
- "true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.
setDestdir
public void setDestdir(File dir)
Set the directory where the Javadoc output will be generated.
dir
- the destination directory.
setDocencoding
public void setDocencoding(String enc)
Output file encoding name.
enc
- name of the encoding to use.
setDoclet
public void setDoclet(String docletName)
Set the class that starts the doclet used in generating the
documentation.
docletName
- the name of the doclet class.
setDocletPath
public void setDocletPath(Path docletPath)
Set the classpath used to find the doclet class.
docletPath
- the doclet classpath.
setDocletPathRef
public void setDocletPathRef(Reference r)
Set the classpath used to find the doclet class by reference.
r
- the reference to the Path instance to use as the doclet
classpath.
setDoctitle
public void setDoctitle(String doctitle)
Set the title of the generated overview page.
doctitle
- the Document title.
setEncoding
public void setEncoding(String enc)
Set the encoding name of the source files,
enc
- the name of the encoding for the source files.
setExcludePackageNames
public void setExcludePackageNames(String packages)
Set the list of packages to be excluded.
packages
- a comma separated list of packages to be excluded.
This may not include wildcards.
setExecutable
public void setExecutable(String executable)
Sets the actual executable command to invoke, instead of the binary
javadoc
found in Ant's JDK.
- Ant 1.6.3
setExtdirs
public void setExtdirs(String path)
Use the setExtdirs(Path)
version.
Set the location of the extensions directories.
path
- the string version of the path.
setExtdirs
public void setExtdirs(Path path)
Set the location of the extensions directories.
path
- a path containing the extension directories.
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.
setFooter
public void setFooter(String footer)
Set the footer text to be placed at the bottom of each output file.
footer
- the footer text.
setGroup
public void setGroup(String src)
Group specified packages together in overview page.
src
- the group packages - a command separated list of group specs,
each one being a group name and package specification separated
by a space.
setHeader
public void setHeader(String header)
Set the header text to be placed at the top of each output file.
header
- the header text
setHelpfile
public void setHelpfile(File f)
Specifies the HTML help file to use.
f
- the file containing help content.
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.
- Ant 1.6.3
setLink
public void setLink(String src)
Create links to javadoc output at the given URL.
setLinkoffline
public void setLinkoffline(String src)
Link to docs at "url" using package list at "url2"
- separate the URLs by using a space character.
src
- the offline link specification (url and package list)
setLinksource
public void setLinksource(boolean b)
Enables the -linksource switch, will be ignored if javadoc is not
the 1.4 version. Default is false
- Ant 1.6
setLocale
public void setLocale(String locale)
Set the local to use in documentation generation.
locale
- the locale to use.
setMaxmemory
public void setMaxmemory(String max)
Set the maximum memory to be used by the javadoc process
max
- a string indicating the maximum memory according to the
JVM conventions (e.g. 128m is 128 Megabytes)
setNodeprecated
public void setNodeprecated(boolean b)
Control deprecation infromation
b
- If true, do not include deprecated information.
setNodeprecatedlist
public void setNodeprecatedlist(boolean b)
Control deprecated list generation
b
- if true, do not generate deprecated list.
setNohelp
public void setNohelp(boolean b)
Control generation of help link.
b
- if true, do not generate help link
setNoindex
public void setNoindex(boolean b)
Control generation of index.
b
- if true, do not generate index.
setNonavbar
public void setNonavbar(boolean b)
Control generation of the navigation bar.
b
- if true, do not generate navigation bar.
setNoqualifier
public void setNoqualifier(String noqualifier)
Enables the -noqualifier switch, will be ignored if javadoc is not
the 1.4 version.
- Ant 1.6
setNotree
public void setNotree(boolean b)
Control class tree generation.
b
- if true, do not generate class hierarchy.
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
b
- if true attempt to generate old style documentation.
setOverview
public void setOverview(File f)
Specify the file containing the overview to be included in the generated
documentation.
f
- the file containing the overview.
setPackage
public void setPackage(boolean b)
Indicate whether only package, protected and public classes and
members are to be included in the scope processed
b
- true if scope is to be package level.
setPackageList
public void setPackageList(String src)
The name of a file containing the packages to process.
src
- the file containing the package list.
setPackagenames
public void setPackagenames(String packages)
Set the package names to be processed.
packages
- a comma separated list of packages specs
(may be wildcarded).
for wildcard information.
setPrivate
public void setPrivate(boolean b)
Indicate whether all classes and
members are to be included in the scope processed
b
- true if scope is to be private level.
setProtected
public void setProtected(boolean b)
Indicate whether only protected and public classes and members are to
be included in the scope processed
b
- true if scope is to be protected.
setPublic
public void setPublic(boolean b)
Indicate whether only public classes and members are to be included in
the scope processed
b
- true if scope is to be public.
setSerialwarn
public void setSerialwarn(boolean b)
Control warnings about serial tag.
b
- if true, generate warning about the serial tag.
setSource
public void setSource(String source)
Enables the -source switch, will be ignored if javadoc is not
the 1.4 version.
- Ant 1.5
setSourcefiles
public void setSourcefiles(String src)
Set the list of source files to process.
src
- a comma separated list of source files.
setSourcepath
public void setSourcepath(Path src)
Specify where to find source file
src
- a Path instance containing the various source directories.
setSourcepathRef
public void setSourcepathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
r
- the reference containing the source path definition.
setSplitindex
public void setSplitindex(boolean b)
Generate a split index
b
- true if the index should be split into a file per letter.
setStylesheetfile
public void setStylesheetfile(File f)
Specifies the CSS stylesheet file to use.
f
- the file with the CSS to use.
setUse
public void setUse(boolean b)
Generate the "use" page for each package.
b
- true if the use page should be generated.
setUseExternalFile
public void setUseExternalFile(boolean b)
Work around command line length limit by using an external file
for the sourcefiles.
b
- true if an external file is to be used.
setVerbose
public void setVerbose(boolean b)
Run javadoc in verbose mode
b
- true if operation is to be verbose.
setVersion
public void setVersion(boolean b)
Include the version tag in the generated documentation.
b
- true if the version tag should be included.
setWindowtitle
public void setWindowtitle(String title)
Set the title to be placed in the HTML <title> tag of the
generated documentation.
title
- the window title to use.