|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.Javadoc
This task makes it easy to generate Javadoc documentation for a collection of source code.
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.
Inner Class Summary | |
static class |
Javadoc.AccessType
|
class |
Javadoc.DocletInfo
|
class |
Javadoc.DocletParam
|
class |
Javadoc.GroupArgument
|
static class |
Javadoc.Html
|
class |
Javadoc.LinkArgument
|
static class |
Javadoc.PackageName
|
static class |
Javadoc.SourceFile
|
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
Javadoc()
|
Method Summary | |
void |
addBottom(Javadoc.Html text)
|
void |
addDoctitle(Javadoc.Html text)
|
void |
addExcludePackage(Javadoc.PackageName pn)
|
void |
addFooter(Javadoc.Html text)
|
void |
addHeader(Javadoc.Html text)
|
void |
addPackage(Javadoc.PackageName pn)
|
void |
addSource(Javadoc.SourceFile sf)
|
Path |
createBootclasspath()
|
Path |
createClasspath()
|
Javadoc.DocletInfo |
createDoclet()
|
Javadoc.GroupArgument |
createGroup()
|
Javadoc.LinkArgument |
createLink()
|
Path |
createSourcepath()
|
void |
execute()
Called by the project to let the task do it's work. |
protected java.lang.String |
expand(java.lang.String content)
Convenience method to expand properties. |
void |
setAccess(Javadoc.AccessType at)
|
void |
setAdditionalparam(java.lang.String add)
|
void |
setAuthor(boolean src)
|
void |
setBootclasspath(Path src)
|
void |
setBootClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere. |
void |
setBottom(java.lang.String src)
|
void |
setCharset(java.lang.String src)
|
void |
setClasspath(Path src)
|
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(java.io.File dir)
|
void |
setDocencoding(java.lang.String enc)
|
void |
setDoclet(java.lang.String src)
|
void |
setDocletPath(Path src)
|
void |
setDocletPathRef(Reference r)
|
void |
setDoctitle(java.lang.String src)
|
void |
setEncoding(java.lang.String enc)
|
void |
setExcludePackageNames(java.lang.String src)
|
void |
setExtdirs(java.lang.String src)
|
void |
setFailonerror(boolean b)
Should the build process fail if javadoc fails (as indicated by a non zero return code)? |
void |
setFooter(java.lang.String src)
|
void |
setGroup(java.lang.String src)
|
void |
setHeader(java.lang.String src)
|
void |
setHelpfile(java.io.File f)
|
void |
setLink(java.lang.String src)
|
void |
setLinkoffline(java.lang.String src)
|
void |
setLocale(java.lang.String src)
|
void |
setMaxmemory(java.lang.String max)
|
void |
setNodeprecated(boolean b)
|
void |
setNodeprecatedlist(boolean b)
|
void |
setNohelp(boolean b)
|
void |
setNoindex(boolean b)
|
void |
setNonavbar(boolean b)
|
void |
setNotree(boolean b)
|
void |
setOld(boolean b)
|
void |
setOverview(java.io.File f)
|
void |
setPackage(boolean b)
|
void |
setPackageList(java.lang.String src)
|
void |
setPackagenames(java.lang.String src)
|
void |
setPrivate(boolean b)
|
void |
setProtected(boolean b)
|
void |
setPublic(boolean b)
|
void |
setSerialwarn(boolean b)
|
void |
setSourcefiles(java.lang.String src)
|
void |
setSourcepath(Path src)
|
void |
setSourcepathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere. |
void |
setSplitindex(boolean b)
|
void |
setStylesheetfile(java.io.File f)
|
void |
setUse(boolean b)
|
void |
setUseExternalFile(boolean b)
Work around command line length limit by using an external file for the sourcefiles. |
void |
setVerbose(boolean b)
|
void |
setVersion(boolean src)
|
void |
setWindowtitle(java.lang.String src)
|
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Javadoc()
Method Detail |
public void setUseExternalFile(boolean b)
public void setDefaultexcludes(boolean useDefaultExcludes)
useDefaultExcludes
- "true"|"on"|"yes" when default exclusions
should be used, "false"|"off"|"no" when they
shouldn't be used.public void setMaxmemory(java.lang.String max)
public void setAdditionalparam(java.lang.String add)
public void setSourcepath(Path src)
public Path createSourcepath()
public void setSourcepathRef(Reference r)
public void setDestdir(java.io.File dir)
public void setSourcefiles(java.lang.String src)
public void addSource(Javadoc.SourceFile sf)
public void setPackagenames(java.lang.String src)
public void addPackage(Javadoc.PackageName pn)
public void setExcludePackageNames(java.lang.String src)
public void addExcludePackage(Javadoc.PackageName pn)
public void setOverview(java.io.File f)
public void setPublic(boolean b)
public void setProtected(boolean b)
public void setPackage(boolean b)
public void setPrivate(boolean b)
public void setAccess(Javadoc.AccessType at)
public void setDoclet(java.lang.String src)
public void setDocletPath(Path src)
public void setDocletPathRef(Reference r)
public Javadoc.DocletInfo createDoclet()
public void setOld(boolean b)
public void setClasspath(Path src)
public Path createClasspath()
public void setClasspathRef(Reference r)
public void setBootclasspath(Path src)
public Path createBootclasspath()
public void setBootClasspathRef(Reference r)
public void setExtdirs(java.lang.String src)
public void setVerbose(boolean b)
public void setLocale(java.lang.String src)
public void setEncoding(java.lang.String enc)
public void setVersion(boolean src)
public void setUse(boolean b)
public void setAuthor(boolean src)
public void setSplitindex(boolean b)
public void setWindowtitle(java.lang.String src)
public void setDoctitle(java.lang.String src)
public void addDoctitle(Javadoc.Html text)
public void setHeader(java.lang.String src)
public void addHeader(Javadoc.Html text)
public void setFooter(java.lang.String src)
public void addFooter(Javadoc.Html text)
public void setBottom(java.lang.String src)
public void addBottom(Javadoc.Html text)
public void setLinkoffline(java.lang.String src)
public void setGroup(java.lang.String src)
public void setLink(java.lang.String src)
public void setNodeprecated(boolean b)
public void setNodeprecatedlist(boolean b)
public void setNotree(boolean b)
public void setNoindex(boolean b)
public void setNohelp(boolean b)
public void setNonavbar(boolean b)
public void setSerialwarn(boolean b)
public void setStylesheetfile(java.io.File f)
public void setHelpfile(java.io.File f)
public void setDocencoding(java.lang.String enc)
public void setPackageList(java.lang.String src)
public Javadoc.LinkArgument createLink()
public Javadoc.GroupArgument createGroup()
public void setCharset(java.lang.String src)
public void setFailonerror(boolean b)
Default is false.
public void execute() throws BuildException
Task
execute
in class Task
org.apache.tools.ant.Task
BuildException
- if someting goes wrong with the buildprotected java.lang.String expand(java.lang.String content)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |