Method Summary |
|
public void | addBottom(Html text) Set the text to be placed at the bottom of each output file. |
public void | addDoctitle(Html text) Add a document title to use for the overview page. |
public void | addExcludePackage(PackageName pn) Add a package to be excluded from the Javadoc run. |
public void | addFileset(FileSet fs) Adds a fileset.
All included files will be added as sourcefiles. |
public void | addFooter(Html text) Set the footer text to be placed at the bottom of each output file. |
public void | addHeader(Html text) Set the header text to be placed at the top of each output file. |
public void | addPackage(PackageName pn) Add a single package to be processed. |
public void | addPackageset(DirSet packageSet) Adds a packageset. |
public void | addSource(SourceFile sf) Add a single source file. |
public void | addTaglet(ExtensionInfo tagletInfo) |
public Commandline.Argument | createArg() Adds a command-line argument. |
public Path | createBootclasspath() |
public Path | createClasspath() |
public DocletInfo | createDoclet() Create a doclet to be used in the documentation generation. |
public GroupArgument | createGroup() Separates packages on the overview page into whatever
groups you specify, one group per table. |
public LinkArgument | createLink() Create link to Javadoc output at the given URL. |
public ResourceCollectionContainer | createSourceFiles() Adds a container for resource collections. |
public Path | createSourcepath() Create a path to be configured with the locations of the source
files. |
public TagArgument | createTag() Creates and adds a -tag argument. |
public void | execute() Execute the task. |
protected String | expand(String content) Convenience method to expand properties. |
public void | setAccess(AccessType at) Set the scope to be processed. |
public void | setAdditionalparam(String add) |
public void | setAuthor(boolean b) Include the author tag in the generated documentation. |
public void | setBootClasspathRef(Reference r) Adds a reference to a CLASSPATH defined elsewhere. |
public void | setBootclasspath(Path path) Set the boot classpath to use. |
public void | setBottom(String bottom) Set the text to be placed at the bottom of each output file. |
public void | setBreakiterator(boolean b) Enables the -linksource switch, will be ignored if Javadoc is not
the 1.4 version. |
public void | setCharset(String src) Charset for cross-platform viewing of generated documentation. |
public void | setClasspath(Path path) Set the classpath to be used for this Javadoc run. |
public void | setClasspathRef(Reference r) Adds a reference to a CLASSPATH defined elsewhere. |
public void | setDefaultexcludes(boolean useDefaultExcludes) Sets whether default exclusions should be used or not. |
public void | setDestdir(File dir) Set the directory where the Javadoc output will be generated. |
public void | setDocencoding(String enc) Output file encoding name. |
public void | setDoclet(String docletName) Set the class that starts the doclet used in generating the
documentation. |
public void | setDocletPath(Path docletPath) Set the classpath used to find the doclet class. |
public void | setDocletPathRef(Reference r) Set the classpath used to find the doclet class by reference. |
public void | setDoctitle(String doctitle) Set the title of the generated overview page. |
public void | setEncoding(String enc) |
public void | setExcludePackageNames(String packages) Set the list of packages to be excluded. |
public void | setExecutable(String executable) Sets the actual executable command to invoke, instead of the binary
javadoc found in Ant's JDK. |
public void | setExtdirs(String path) Set the location of the extensions directories. |
public void | setExtdirs(Path path) Set the location of the extensions directories. |
public void | setFailonerror(boolean b) |
public void | setFooter(String footer) Set the footer text to be placed at the bottom of each output file. |
public void | setGroup(String src) Group specified packages together in overview page. |
public void | setHeader(String header) Set the header text to be placed at the top of each output file. |
public void | setHelpfile(File f) Specifies the HTML help file to use. |
public void | setIncludeNoSourcePackages(boolean b) If set to true, Ant will also accept packages that only hold
package.html files but no Java sources. |
public void | setLink(String src) Create links to Javadoc output at the given URL. |
public void | setLinkoffline(String src) Link to docs at "url" using package list at "url2"
- separate the URLs by using a space character. |
public void | setLinksource(boolean b) Enables the -linksource switch, will be ignored if Javadoc is not
the 1.4 version. |
public void | setLocale(String locale) Set the local to use in documentation generation. |
public void | setMaxmemory(String max) Set the maximum memory to be used by the javadoc process
Parameters: max - a string indicating the maximum memory according to theJVM conventions (e.g. |
public void | setNodeprecated(boolean b) |
public void | setNodeprecatedlist(boolean b) |
public void | setNohelp(boolean b) Control generation of help link. |
public void | setNoindex(boolean b) Control generation of index. |
public void | setNonavbar(boolean b) Control generation of the navigation bar. |
public void | setNoqualifier(String noqualifier) Enables the -noqualifier switch, will be ignored if Javadoc is not
the 1.4 version. |
public void | setNotree(boolean b) Control class tree generation. |
public void | setOld(boolean b) Indicate whether Javadoc should produce old style (JDK 1.1)
documentation. |
public void | setOverview(File f) Specify the file containing the overview to be included in the generated
documentation. |
public void | setPackage(boolean b) |
public void | setPackageList(String src) The name of a file containing the packages to process. |
public void | setPackagenames(String packages) Set the package names to be processed. |
public void | setPrivate(boolean b) |
public void | setProtected(boolean b) |
public void | setPublic(boolean b) |
public void | setSerialwarn(boolean b) Control warnings about serial tag. |
public void | setSource(String source) Enables the -source switch, will be ignored if Javadoc is not
the 1.4 version. |
public void | setSourcefiles(String src) Set the list of source files to process. |
public void | setSourcepath(Path src) |
public void | setSourcepathRef(Reference r) Adds a reference to a CLASSPATH defined elsewhere. |
public void | setSplitindex(boolean b) |
public void | setStylesheetfile(File f) Specifies the CSS stylesheet file to use. |
public void | setUse(boolean b) Generate the "use" page for each package. |
public void | setUseExternalFile(boolean b) Work around command line length limit by using an external file
for the sourcefiles. |
public void | setVerbose(boolean b) |
public void | setVersion(boolean b) Include the version tag in the generated documentation. |
public void | setWindowtitle(String title) Set the title to be placed in the HTML <title> tag of the
generated documentation. |