org.apache.tools.ant.taskdefs
Class Javadoc
java.lang.Object
|
+--org.apache.tools.ant.Task
|
+--org.apache.tools.ant.taskdefs.Javadoc
- public class Javadoc
- extends Task
This task makes it easy to generate 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.
- the java comment-stripper reader is horribly slow
- there is no control on arguments sanity since they are left
to the javadoc implementation.
- argument J in javadoc1 is not supported (what is that for anyway?)
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.
- Author:
- Jon S. Stevens jon@clearink.com, Stefano Mazzocchi stefano@apache.org, Patrick Chanezon chanezon@netscape.com, Ernst de Haan ernst@jollem.com
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getProject, getRuntimeConfigurableWrapper, getTaskName, init, log, log, maybeConfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Javadoc
public Javadoc()
setMaxmemory
public void setMaxmemory(java.lang.String max)
setAdditionalparam
public void setAdditionalparam(java.lang.String add)
setSourcepath
public void setSourcepath(Path src)
createSourcepath
public Path createSourcepath()
setSourcepathRef
public void setSourcepathRef(Reference r)
- Adds a reference to a CLASSPATH defined elsewhere.
setDestdir
public void setDestdir(java.io.File dir)
setSourcefiles
public void setSourcefiles(java.lang.String src)
setPackagenames
public void setPackagenames(java.lang.String src)
setOverview
public void setOverview(java.io.File f)
setPublic
public void setPublic(boolean b)
setProtected
public void setProtected(boolean b)
setPackage
public void setPackage(boolean b)
setPrivate
public void setPrivate(boolean b)
setDoclet
public void setDoclet(java.lang.String src)
setDocletPath
public void setDocletPath(Path src)
setDocletPathRef
public void setDocletPathRef(Reference r)
createDoclet
public Javadoc.DocletInfo createDoclet()
setOld
public void setOld(boolean b)
setClasspath
public void setClasspath(Path src)
createClasspath
public Path createClasspath()
setClasspathRef
public void setClasspathRef(Reference r)
- Adds a reference to a CLASSPATH defined elsewhere.
setBootclasspath
public void setBootclasspath(Path src)
createBootclasspath
public Path createBootclasspath()
setBootClasspathRef
public void setBootClasspathRef(Reference r)
- Adds a reference to a CLASSPATH defined elsewhere.
setExtdirs
public void setExtdirs(java.lang.String src)
setVerbose
public void setVerbose(boolean b)
setLocale
public void setLocale(java.lang.String src)
setEncoding
public void setEncoding(java.lang.String enc)
setVersion
public void setVersion(boolean src)
setUse
public void setUse(boolean b)
setAuthor
public void setAuthor(boolean src)
setSplitindex
public void setSplitindex(boolean b)
setWindowtitle
public void setWindowtitle(java.lang.String src)
setDoctitle
public void setDoctitle(java.lang.String src)
setHeader
public void setHeader(java.lang.String src)
setFooter
public void setFooter(java.lang.String src)
setBottom
public void setBottom(java.lang.String src)
setLinkoffline
public void setLinkoffline(java.lang.String src)
setGroup
public void setGroup(java.lang.String src)
setLink
public void setLink(java.lang.String src)
setNodeprecated
public void setNodeprecated(boolean b)
setNodeprecatedlist
public void setNodeprecatedlist(boolean b)
setNotree
public void setNotree(boolean b)
setNoindex
public void setNoindex(boolean b)
setNohelp
public void setNohelp(boolean b)
setNonavbar
public void setNonavbar(boolean b)
setSerialwarn
public void setSerialwarn(boolean b)
setStylesheetfile
public void setStylesheetfile(java.io.File f)
setHelpfile
public void setHelpfile(java.io.File f)
setDocencoding
public void setDocencoding(java.lang.String enc)
setPackageList
public void setPackageList(java.lang.String src)
createLink
public Javadoc.LinkArgument createLink()
createGroup
public Javadoc.GroupArgument createGroup()
setCharset
public void setCharset(java.lang.String src)
execute
public void execute()
throws BuildException
- Description copied from class:
Task
- Called by the project to let the task do it's work. Normally it does nothing.
- Overrides:
execute
in class Task
- Following copied from class:
org.apache.tools.ant.Task
- Throws:
BuildException
- if someting goes wrong with the build
findPackages
protected java.util.Vector findPackages(java.io.File srcDir)
scan
protected void scan(java.io.File srcDir,
java.lang.String vpath,
java.util.Vector pkgs)
Copyright © 2000 Apache Software Foundation. All Rights Reserved.