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:
- Cloneable
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 SummaryNested ClassesModifier and TypeClassDescriptionstatic classEnumeratedAttribute implementation supporting the Javadoc scoping values.classThis class stores info about doclets.classInner class used to manage doclet parameters.static classA project aware class used for Javadoc extensions which take a name and a path such as doclet and taglet arguments.classA class corresponding to the group nested element.static classAn HTML element in the Javadoc.classRepresents a link triplet (href, whether link is offline, location of the package list if off line)static classUsed to track info about the packages to be javadoc'dclassHolds a collection of ResourceCollections.static classThis class is used to manage the source files to be processed.classClass representing a -tag argument.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddBottom(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.voidAdd 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.voidAdd a single module to be processed.voidAdd a single package to be processed.voidaddPackageset(DirSet packageSet) Adds a packageset.voidAdd a single source file.voidaddTaglet(Javadoc.ExtensionInfo tagletInfo) Add a tagletAdds a command-line argument.Create a Path to be configured with the boot classpathCreate a Path to be configured with the classpath to useCreate a doclet to be used in the documentation generation.Separates packages on the overview page into whatever groups you specify, one group per table.Create link to Javadoc output at the given URL.Create a path to be configured with the locations of the module files.Create a path to be configured with the locations of the module source files.Adds a container for resource collections.Create a path to be configured with the locations of the source files.Creates and adds a -tag argument.voidexecute()Execute the task.protected StringConvenience method to expand properties.voidSet the scope to be processed.voidsetAdditionalparam(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.voidAdds a reference to a CLASSPATH defined elsewhere.voidSet 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(String src) Charset for cross-platform viewing of generated documentation.voidsetClasspath(Path path) Set the classpath to be used for this Javadoc run.voidAdds a reference to a CLASSPATH defined elsewhere.voidsetDefaultexcludes(boolean useDefaultExcludes) Sets whether default exclusions should be used or not.voidsetDestdir(File dir) Set the directory where the Javadoc output will be generated.voidsetDocencoding(String enc) Output file encoding name.voidsetDocFilesSubDirs(boolean b) Enables deep-copying ofdoc-filesdirectories.voidSet the class that starts the doclet used in generating the documentation.voidsetDocletPath(Path docletPath) Set the classpath used to find the doclet class.voidSet the classpath used to find the doclet class by reference.voidsetDoctitle(String doctitle) Set the title of the generated overview page.voidsetEncoding(String enc) Set the encoding name of the source files,voidColon-separated list ofdoc-filessubdirectories to skip ifdocFilesSubDirs is true.voidsetExcludePackageNames(String packages) Set the list of packages to be excluded.voidsetExecutable(String executable) Sets the actual executable command to invoke, instead of the binaryjavadocfound in Ant's JDK.voidsetExtdirs(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)?voidSet the footer text to be placed at the bottom of each output file.voidGroup specified packages together in overview page.voidSet the header text to be placed at the top of each output file.voidsetHelpfile(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.voidCreate links to Javadoc output at the given URL.voidsetLinkoffline(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.voidSet the local to use in documentation generation.voidsetMaxmemory(String max) Set the maximum memory to be used by the javadoc processvoidsetModulenames(String modules) Set the module names to be processed.voidsetModulePath(Path mp) Specify where to find modulesvoidAdds a reference to a path defined elsewhere that defines the module path.voidSpecify where to find sources for modulesvoidAdds 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(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(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(String src) The name of a file containing the packages to process.voidsetPackagenames(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.voidEnables the -source switch, will be ignored if Javadoc is not the 1.4 version.voidsetSourcefiles(String src) Set the list of source files to process.voidsetSourcepath(Path src) Specify where to find source filevoidAdds a reference to a CLASSPATH defined elsewhere.voidsetSplitindex(boolean b) Generate a split indexvoidSpecifies 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(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.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
Javadocpublic Javadoc()
 
- 
- 
Method Details- 
setUseExternalFilepublic 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.
 
- 
setDefaultexcludespublic 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.
 
- 
setMaxmemorySet 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)
 
- 
setAdditionalparamSet an additional parameter on the command line- Parameters:
- add- the additional command line parameter for the javadoc task.
 
- 
createArgAdds a command-line argument.- Returns:
- a command-line argument to configure
- Since:
- Ant 1.6
 
- 
setSourcepathSpecify where to find source file- Parameters:
- src- a Path instance containing the various source directories.
 
- 
createSourcepathCreate a path to be configured with the locations of the source files.- Returns:
- a new Path instance to be configured by the Ant core.
 
- 
setSourcepathRefAdds a reference to a CLASSPATH defined elsewhere.- Parameters:
- r- the reference containing the source path definition.
 
- 
setModulePathSpecify where to find modules- Parameters:
- mp- a Path instance containing the modules.
- Since:
- Ant 1.10.6
 
- 
createModulePathCreate 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
 
- 
setModulePathrefAdds 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
 
- 
setModuleSourcePathSpecify where to find sources for modules- Parameters:
- mp- a Path instance containing the sources for modules.
- Since:
- Ant 1.10.6
 
- 
createModuleSourcePathCreate 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
 
- 
setModuleSourcePathrefAdds 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
 
- 
setDestdirSet the directory where the Javadoc output will be generated.- Parameters:
- dir- the destination directory.
 
- 
setSourcefilesSet the list of source files to process.- Parameters:
- src- a comma separated list of source files.
 
- 
addSourceAdd a single source file.- Parameters:
- sf- the source file to be processed.
 
- 
setPackagenamesSet the package names to be processed.- Parameters:
- packages- a comma separated list of packages specs (may be wildcarded).
- See Also:
 
- 
setModulenamesSet the module names to be processed.- Parameters:
- modules- a comma separated list of module names
- Since:
- Ant 1.10.6
 
- 
addPackageAdd 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.
 
- 
addModuleAdd a single module to be processed.- Parameters:
- mn- the module name
- Since:
- Ant 1.10.6
 
- 
setExcludePackageNamesSet the list of packages to be excluded.- Parameters:
- packages- a comma separated list of packages to be excluded. This may not include wildcards.
 
- 
addExcludePackageAdd a package to be excluded from the Javadoc run.- Parameters:
- pn- the name of the package (wildcards are not permitted).
 
- 
setOverviewSpecify the file containing the overview to be included in the generated documentation.- Parameters:
- f- the file containing the overview.
 
- 
setPublicpublic 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.
 
- 
setProtectedpublic 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.
 
- 
setPackagepublic 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.
 
- 
setPrivatepublic 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.
 
- 
setAccessSet 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.
 
- 
setDocletSet the class that starts the doclet used in generating the documentation.- Parameters:
- docletName- the name of the doclet class.
 
- 
setDocletPathSet the classpath used to find the doclet class.- Parameters:
- docletPath- the doclet classpath.
 
- 
setDocletPathRefSet the classpath used to find the doclet class by reference.- Parameters:
- r- the reference to the Path instance to use as the doclet classpath.
 
- 
createDocletCreate a doclet to be used in the documentation generation.- Returns:
- a new DocletInfo instance to be configured.
 
- 
addTagletAdd a taglet- Parameters:
- tagletInfo- information about the taglet.
 
- 
setOldpublic 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.
 
- 
setClasspathSet the classpath to be used for this Javadoc run.- Parameters:
- path- an Ant Path object containing the compilation classpath.
 
- 
createClasspathCreate a Path to be configured with the classpath to use- Returns:
- a new Path instance to be configured with the classpath.
 
- 
setClasspathRefAdds a reference to a CLASSPATH defined elsewhere.- Parameters:
- r- the reference to an instance defining the classpath.
 
- 
setBootclasspathSet the boot classpath to use.- Parameters:
- path- the boot classpath.
 
- 
createBootclasspathCreate a Path to be configured with the boot classpath- Returns:
- a new Path instance to be configured with the boot classpath.
 
- 
setBootClasspathRefAdds a reference to a CLASSPATH defined elsewhere.- Parameters:
- r- the reference to an instance defining the bootclasspath.
 
- 
setExtdirsDeprecated.since 1.5.x. Use thesetExtdirs(Path)version.Set the location of the extensions directories.- Parameters:
- path- the string version of the path.
 
- 
setExtdirsSet the location of the extensions directories.- Parameters:
- path- a path containing the extension directories.
 
- 
setVerbosepublic void setVerbose(boolean b) Run javadoc in verbose mode- Parameters:
- b- true if operation is to be verbose.
 
- 
setLocaleSet the local to use in documentation generation.- Parameters:
- locale- the locale to use.
 
- 
setEncodingSet the encoding name of the source files,- Parameters:
- enc- the name of the encoding for the source files.
 
- 
setVersionpublic void setVersion(boolean b) Include the version tag in the generated documentation.- Parameters:
- b- true if the version tag should be included.
 
- 
setUsepublic void setUse(boolean b) Generate the "use" page for each package.- Parameters:
- b- true if the use page should be generated.
 
- 
setAuthorpublic void setAuthor(boolean b) Include the author tag in the generated documentation.- Parameters:
- b- true if the author tag should be included.
 
- 
setSplitindexpublic void setSplitindex(boolean b) Generate a split index- Parameters:
- b- true if the index should be split into a file per letter.
 
- 
setWindowtitleSet the title to be placed in the HTML <title> tag of the generated documentation.- Parameters:
- title- the window title to use.
 
- 
setDoctitleSet the title of the generated overview page.- Parameters:
- doctitle- the Document title.
 
- 
addDoctitleAdd a document title to use for the overview page.- Parameters:
- text- the HTML element containing the document title.
 
- 
setHeaderSet the header text to be placed at the top of each output file.- Parameters:
- header- the header text
 
- 
addHeaderSet the header text to be placed at the top of each output file.- Parameters:
- text- the header text
 
- 
setBottomSet the text to be placed at the bottom of each output file.- Parameters:
- bottom- the bottom text.
 
- 
addBottomSet the text to be placed at the bottom of each output file.- Parameters:
- text- the bottom text.
 
- 
setLinkofflineLink 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)
 
- 
setGroupGroup 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.
 
- 
setLinkCreate links to Javadoc output at the given URL.- Parameters:
- src- the URL to link to
 
- 
setNodeprecatedpublic void setNodeprecated(boolean b) Control deprecation information- Parameters:
- b- If true, do not include deprecated information.
 
- 
setNodeprecatedlistpublic void setNodeprecatedlist(boolean b) Control deprecated list generation- Parameters:
- b- if true, do not generate deprecated list.
 
- 
setNotreepublic void setNotree(boolean b) Control class tree generation.- Parameters:
- b- if true, do not generate class hierarchy.
 
- 
setNoindexpublic void setNoindex(boolean b) Control generation of index.- Parameters:
- b- if true, do not generate index.
 
- 
setNohelppublic void setNohelp(boolean b) Control generation of help link.- Parameters:
- b- if true, do not generate help link
 
- 
setSerialwarnpublic void setSerialwarn(boolean b) Control warnings about serial tag.- Parameters:
- b- if true, generate warning about the serial tag.
 
- 
setStylesheetfileSpecifies the CSS stylesheet file to use.- Parameters:
- f- the file with the CSS to use.
 
- 
setHelpfileSpecifies the HTML help file to use.- Parameters:
- f- the file containing help content.
 
- 
setDocencodingOutput file encoding name.- Parameters:
- enc- name of the encoding to use.
 
- 
setPackageListThe name of a file containing the packages to process.- Parameters:
- src- the file containing the package list.
 
- 
createLinkCreate link to Javadoc output at the given URL.- Returns:
- link argument to configure
 
- 
createTagCreates 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
 
- 
createGroupSeparates packages on the overview page into whatever groups you specify, one group per table.- Returns:
- a group argument to be configured
 
- 
setCharsetCharset for cross-platform viewing of generated documentation.- Parameters:
- src- the name of the charset
 
- 
setFailonerrorpublic 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- a- booleanvalue
 
- 
setFailonwarningpublic 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- a- booleanvalue
- Since:
- Ant 1.9.4
 
- 
setSourceEnables the -source switch, will be ignored if Javadoc is not the 1.4 version.- Parameters:
- source- a- Stringvalue
- Since:
- Ant 1.5
 
- 
setExecutableSets 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
 
- 
addPackagesetAdds 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
 
- 
addFilesetAdds 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
 
- 
createSourceFilesAdds a container for resource collections.All included files will be added as sourcefiles. - Returns:
- the source files to configure.
- Since:
- 1.7
 
- 
setLinksourcepublic void setLinksource(boolean b) Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version. Default is false- Parameters:
- b- a- Stringvalue
- Since:
- Ant 1.6
 
- 
setBreakiteratorpublic void setBreakiterator(boolean b) Enables the -linksource switch, will be ignored if Javadoc is not the 1.4 version. Default is false- Parameters:
- b- a- Stringvalue
- Since:
- Ant 1.6
 
- 
setNoqualifierEnables 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
 
- 
setIncludeNoSourcePackagespublic 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- a- booleanvalue.
- Since:
- Ant 1.6.3
 
- 
setDocFilesSubDirspublic void setDocFilesSubDirs(boolean b) Enables deep-copying ofdoc-filesdirectories.- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
setExcludeDocFilesSubDirColon-separated list ofdoc-filessubdirectories to skip ifdocFilesSubDirs is true.- Parameters:
- s- String
- Since:
- Ant 1.8.0
 
- 
setPostProcessGeneratedJavadocspublic 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
 
- 
executeExecute the task.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
- 
expandConvenience method to expand properties.- Parameters:
- content- the string to expand
- Returns:
- the converted string
 
 
-