org.apache.tools.ant.taskdefs
public class Javadoc extends Task
Current known limitations are:
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
UNKNOWN: category="java"
Nested Class Summary | |
---|---|
static class | Javadoc.AccessType
EnumeratedAttribute implementation supporting the Javadoc scoping
values. |
class | Javadoc.DocletInfo
This class stores info about doclets.
|
class | Javadoc.DocletParam
Inner class used to manage doclet parameters. |
static class | Javadoc.ExtensionInfo
A project aware class used for Javadoc extensions which take a name
and a path such as doclet and taglet arguments.
|
class | Javadoc.GroupArgument
A class corresponding to the group nested element. |
static class | Javadoc.Html
An HTML element in the Javadoc.
|
class | Javadoc.LinkArgument
Represents a link triplet (href, whether link is offline,
location of the package list if off line) |
static class | Javadoc.PackageName
Used to track info about the packages to be javadoc'd |
class | Javadoc.ResourceCollectionContainer
Holds a collection of ResourceCollections.
|
static class | Javadoc.SourceFile
This class is used to manage the source files to be processed. |
class | Javadoc.TagArgument
Class representing a -tag argument. |
Method Summary | |
---|---|
void | addBottom(Javadoc.Html text)
Set the text to be placed at the bottom of each output file.
|
void | addDoctitle(Javadoc.Html text)
Add a document title to use for the overview page.
|
void | addExcludePackage(Javadoc.PackageName pn)
Add a package to be excluded from the Javadoc run.
|
void | addFileset(FileSet fs)
Adds a fileset.
|
void | addFooter(Javadoc.Html text)
Set the footer text to be placed at the bottom of each output file.
|
void | addHeader(Javadoc.Html text)
Set the header text to be placed at the top of each output file.
|
void | addPackage(Javadoc.PackageName pn)
Add a single package to be processed.
|
void | addPackageset(DirSet packageSet)
Adds a packageset.
|
void | addSource(Javadoc.SourceFile sf)
Add a single source file.
|
void | addTaglet(Javadoc.ExtensionInfo tagletInfo)
Add a taglet
|
Commandline.Argument | createArg()
Adds a command-line argument. |
Path | createBootclasspath()
Create a Path to be configured with the boot classpath
|
Path | createClasspath()
Create a Path to be configured with the classpath to use
|
Javadoc.DocletInfo | createDoclet()
Create a doclet to be used in the documentation generation.
|
Javadoc.GroupArgument | createGroup()
Separates packages on the overview page into whatever
groups you specify, one group per table. |
Javadoc.LinkArgument | createLink()
Create link to Javadoc output at the given URL.
|
Javadoc.ResourceCollectionContainer | createSourceFiles()
Adds a container for resource collections.
|
Path | createSourcepath()
Create a path to be configured with the locations of the source
files.
|
Javadoc.TagArgument | createTag()
Creates and adds a -tag argument. |
void | execute()
Execute the task. |
protected String | expand(String content)
Convenience method to expand properties. |
void | setAccess(Javadoc.AccessType at)
Set the scope to be processed. |
void | setAdditionalparam(String add)
Set an additional parameter on the command line
|
void | setAuthor(boolean b)
Include the author tag in the generated documentation.
|
void | setBootclasspath(Path path)
Set the boot classpath to use.
|
void | setBootClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
|
void | setBottom(String bottom)
Set the text to be placed at the bottom of each output file.
|
void | setBreakiterator(boolean b)
Enables the -linksource switch, will be ignored if Javadoc is not
the 1.4 version. |
void | setCharset(String src)
Charset for cross-platform viewing of generated documentation. |
void | setClasspath(Path path)
Set the classpath to be used for this Javadoc run.
|
void | setClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
|
void | setDefaultexcludes(boolean useDefaultExcludes)
Sets whether default exclusions should be used or not.
|
void | setDestdir(File dir)
Set the directory where the Javadoc output will be generated.
|
void | setDocencoding(String enc)
Output file encoding name.
|
void | setDoclet(String docletName)
Set the class that starts the doclet used in generating the
documentation.
|
void | setDocletPath(Path docletPath)
Set the classpath used to find the doclet class.
|
void | setDocletPathRef(Reference r)
Set the classpath used to find the doclet class by reference.
|
void | setDoctitle(String doctitle)
Set the title of the generated overview page.
|
void | setEncoding(String enc)
Set the encoding name of the source files,
|
void | setExcludePackageNames(String packages)
Set the list of packages to be excluded.
|
void | setExecutable(String executable)
Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. |
void | setExtdirs(String path)
Set the location of the extensions directories.
|
void | setExtdirs(Path path)
Set the location of the extensions directories.
|
void | setFailonerror(boolean b)
Should the build process fail if Javadoc fails (as indicated by
a non zero return code)?
|
void | setFooter(String footer)
Set the footer text to be placed at the bottom of each output file.
|
void | setGroup(String src)
Group specified packages together in overview page.
|
void | setHeader(String header)
Set the header text to be placed at the top of each output file.
|
void | setHelpfile(File f)
Specifies the HTML help file to use.
|
void | setIncludeNoSourcePackages(boolean b)
If set to true, Ant will also accept packages that only hold
package.html files but no Java sources. |
void | setLink(String src)
Create links to Javadoc output at the given URL. |
void | setLinkoffline(String src)
Link to docs at "url" using package list at "url2"
- separate the URLs by using a space character.
|
void | setLinksource(boolean b)
Enables the -linksource switch, will be ignored if Javadoc is not
the 1.4 version. |
void | setLocale(String locale)
Set the local to use in documentation generation.
|
void | setMaxmemory(String max)
Set the maximum memory to be used by the javadoc process
|
void | setNodeprecated(boolean b)
Control deprecation infromation
|
void | setNodeprecatedlist(boolean b)
Control deprecated list generation
|
void | setNohelp(boolean b)
Control generation of help link.
|
void | setNoindex(boolean b)
Control generation of index.
|
void | setNonavbar(boolean b)
Control generation of the navigation bar.
|
void | setNoqualifier(String noqualifier)
Enables the -noqualifier switch, will be ignored if Javadoc is not
the 1.4 version. |
void | setNotree(boolean b)
Control class tree generation.
|
void | setOld(boolean b)
Indicate whether Javadoc should produce old style (JDK 1.1)
documentation.
|
void | setOverview(File f)
Specify the file containing the overview to be included in the generated
documentation.
|
void | setPackage(boolean b)
Indicate whether only package, protected and public classes and
members are to be included in the scope processed
|
void | setPackageList(String src)
The name of a file containing the packages to process.
|
void | setPackagenames(String packages)
Set the package names to be processed.
|
void | setPrivate(boolean b)
Indicate whether all classes and
members are to be included in the scope processed
|
void | setProtected(boolean b)
Indicate whether only protected and public classes and members are to
be included in the scope processed
|
void | setPublic(boolean b)
Indicate whether only public classes and members are to be included in
the scope processed
|
void | setSerialwarn(boolean b)
Control warnings about serial tag.
|
void | setSource(String source)
Enables the -source switch, will be ignored if Javadoc is not
the 1.4 version. |
void | setSourcefiles(String src)
Set the list of source files to process.
|
void | setSourcepath(Path src)
Specify where to find source file
|
void | setSourcepathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
|
void | setSplitindex(boolean b)
Generate a split index
|
void | setStylesheetfile(File f)
Specifies the CSS stylesheet file to use.
|
void | setUse(boolean b)
Generate the "use" page for each package.
|
void | setUseExternalFile(boolean b)
Work around command line length limit by using an external file
for the sourcefiles.
|
void | setVerbose(boolean b)
Run javadoc in verbose mode
|
void | setVersion(boolean b)
Include the version tag in the generated documentation.
|
void | setWindowtitle(String title)
Set the title to be placed in the HTML <title> tag of the
generated documentation.
|
Parameters: text the bottom text.
Parameters: text the HTML element containing the document title.
Parameters: pn the name of the package (wildcards are not permitted).
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
Parameters: text the footer text.
Parameters: text the header text
Parameters: pn the package name, possibly wildcarded.
All included directories will be translated into package names be converting the directory separator into dots.
Parameters: packageSet a directory set
Since: 1.5
Parameters: sf the source file to be processed.
Parameters: tagletInfo information about the taglet.
Returns: a command-line argument to configure
Since: Ant 1.6
Returns: a new Path instance to be configured with the boot classpath.
Returns: a new Path instance to be configured with the classpath.
Returns: a new DocletInfo instance to be configured.
Returns: a group argument to be configured
Returns: link argument to configure
All included files will be added as sourcefiles.
Returns: the source files to configure.
Since: 1.7
Returns: a new Path instance to be configured by the Ant core.
Returns: tag argument to be configured
Throws: BuildException on error
Parameters: content the string to expand
Returns: the converted string
Parameters: at the scope to be processed.
Parameters: add the additional command line parameter for the javadoc task.
Parameters: b true if the author tag should be included.
Parameters: path the boot classpath.
Parameters: r the reference to an instance defining the bootclasspath.
Parameters: bottom the bottom text.
Parameters: b a String
value
Since: Ant 1.6
Parameters: src the name of the charset
Parameters: path an Ant Path object containing the compilation classpath.
Parameters: r the reference to an instance defining the classpath.
Parameters: useDefaultExcludes "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.
Parameters: dir the destination directory.
Parameters: enc name of the encoding to use.
Parameters: docletName the name of the doclet class.
Parameters: docletPath the doclet classpath.
Parameters: r the reference to the Path instance to use as the doclet classpath.
Parameters: doctitle the Document title.
Parameters: enc the name of the encoding for the source files.
Parameters: packages a comma separated list of packages to be excluded. This may not include wildcards.
javadoc
found in Ant's JDK.Parameters: executable the command to invoke.
Since: Ant 1.6.3
Deprecated: since 1.5.x. Use the setExtdirs version.
Set the location of the extensions directories.Parameters: path the string version of the path.
Parameters: path a path containing the extension directories.
Default is false.
Parameters: b a boolean
value
Parameters: footer the footer text.
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.
Parameters: header the header text
Parameters: f the file containing help content.
Parameters: b a boolean
value.
Since: Ant 1.6.3
Parameters: src the URL to link to
Parameters: src the offline link specification (url and package list)
Parameters: b a String
value
Since: Ant 1.6
Parameters: locale the locale to use.
Parameters: max a string indicating the maximum memory according to the JVM conventions (e.g. 128m is 128 Megabytes)
Parameters: b If true, do not include deprecated information.
Parameters: b if true, do not generate deprecated list.
Parameters: b if true, do not generate help link
Parameters: b if true, do not generate index.
Parameters: b if true, do not generate navigation bar.
Parameters: noqualifier the parameter to the -noqualifier switch
Since: Ant 1.6
Parameters: b if true, do not generate class hierarchy.
Parameters: b if true attempt to generate old style documentation.
Parameters: f the file containing the overview.
Parameters: b true if scope is to be package level.
Parameters: src the file containing the package list.
Parameters: packages a comma separated list of packages specs (may be wildcarded).
See Also: for wildcard information.
Parameters: b true if scope is to be private level.
Parameters: b true if scope is to be protected.
Parameters: b true if scope is to be public.
Parameters: b if true, generate warning about the serial tag.
Parameters: source a String
value
Since: Ant 1.5
Parameters: src a comma separated list of source files.
Parameters: src a Path instance containing the various source directories.
Parameters: r the reference containing the source path definition.
Parameters: b true if the index should be split into a file per letter.
Parameters: f the file with the CSS to use.
Parameters: b true if the use page should be generated.
Parameters: b true if an external file is to be used.
Parameters: b true if operation is to be verbose.
Parameters: b true if the version tag should be included.
Parameters: title the window title to use.