org.apache.tools.ant.taskdefs
Class Javadoc

java.lang.Object
  |
  +--org.apache.tools.ant.Task
        |
        +--org.apache.tools.ant.taskdefs.Exec
              |
              +--org.apache.tools.ant.taskdefs.Javadoc

public class Javadoc
extends Exec

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.

Author:
Jon S. Stevens jon@clearink.com, Stefano Mazzocchi stefano@apache.org, Patrick Chanezon chanezon@netscape.com, Ernst de Haan ernst@jollem.com

Inner Class Summary
 class Javadoc.DocletInfo
           
 class Javadoc.DocletParam
           
 class Javadoc.GroupArgument
           
 class Javadoc.LinkArgument
           
 
Fields inherited from class org.apache.tools.ant.taskdefs.Exec
fos
 
Fields inherited from class org.apache.tools.ant.Task
description, location, project, target, taskName, taskType
 
Constructor Summary
Javadoc()
           
 
Method Summary
 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  void logFlush()
           
protected  void outputLog(java.lang.String line, int messageLevel)
           
 void setadditionalParam(java.lang.String src)
           
 void setAuthor(java.lang.String src)
           
 void setBootclasspath(Path src)
           
 void setBottom(java.lang.String src)
           
 void setCharset(java.lang.String src)
           
 void setClasspath(Path src)
           
 void setDestdir(java.lang.String src)
           
 void setDocencoding(java.lang.String src)
           
 void setDoclet(java.lang.String src)
           
 void setDocletPath(Path src)
           
 void setDoctitle(java.lang.String src)
           
 void setEncoding(java.lang.String src)
           
 void setExtdirs(java.lang.String src)
           
 void setFooter(java.lang.String src)
           
 void setGroup(java.lang.String src)
           
 void setHeader(java.lang.String src)
           
 void setLink(java.lang.String src)
           
 void setLinkoffline(java.lang.String src)
           
 void setLocale(java.lang.String src)
           
 void setMaxmemory(java.lang.String src)
           
 void setNodeprecated(java.lang.String src)
           
 void setNodeprecatedlist(java.lang.String src)
           
 void setNohelp(java.lang.String src)
           
 void setNoindex(java.lang.String src)
           
 void setNonavbar(java.lang.String src)
           
 void setNotree(java.lang.String src)
           
 void setOld(java.lang.String src)
           
 void setOverview(java.lang.String src)
           
 void setPackage(java.lang.String src)
           
 void setPackageList(java.lang.String src)
           
 void setPackagenames(java.lang.String src)
           
 void setPrivate(java.lang.String src)
           
 void setProtected(java.lang.String src)
           
 void setPublic(java.lang.String src)
           
 void setSerialwarn(java.lang.String src)
           
 void setSourcefiles(java.lang.String src)
           
 void setSourcepath(Path src)
           
 void setSplitindex(java.lang.String src)
           
 void setStylesheetfile(java.lang.String src)
           
 void setUse(java.lang.String src)
           
 void setVerbose(java.lang.String src)
           
 void setVersion(java.lang.String src)
           
 void setWindowtitle(java.lang.String src)
           
 
Methods inherited from class org.apache.tools.ant.taskdefs.Exec
run, setCommand, setDir, setFailonerror, setOs, setOutput
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getProject, getTaskName, init, log, log, setDescription, setLocation, setOwningTarget, setTaskName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Javadoc

public Javadoc()
Method Detail

setMaxmemory

public void setMaxmemory(java.lang.String src)

setadditionalParam

public void setadditionalParam(java.lang.String src)

setSourcepath

public void setSourcepath(Path src)

createSourcepath

public Path createSourcepath()

setDestdir

public void setDestdir(java.lang.String src)

setSourcefiles

public void setSourcefiles(java.lang.String src)

setPackagenames

public void setPackagenames(java.lang.String src)

setOverview

public void setOverview(java.lang.String src)

setPublic

public void setPublic(java.lang.String src)

setProtected

public void setProtected(java.lang.String src)

setPackage

public void setPackage(java.lang.String src)

setPrivate

public void setPrivate(java.lang.String src)

setDoclet

public void setDoclet(java.lang.String src)

setDocletPath

public void setDocletPath(Path src)

createDoclet

public Javadoc.DocletInfo createDoclet()

setOld

public void setOld(java.lang.String src)

setClasspath

public void setClasspath(Path src)

createClasspath

public Path createClasspath()

setBootclasspath

public void setBootclasspath(Path src)

createBootclasspath

public Path createBootclasspath()

setExtdirs

public void setExtdirs(java.lang.String src)

setVerbose

public void setVerbose(java.lang.String src)

setLocale

public void setLocale(java.lang.String src)

setEncoding

public void setEncoding(java.lang.String src)

setVersion

public void setVersion(java.lang.String src)

setUse

public void setUse(java.lang.String src)

setAuthor

public void setAuthor(java.lang.String src)

setSplitindex

public void setSplitindex(java.lang.String src)

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(java.lang.String src)

setNodeprecatedlist

public void setNodeprecatedlist(java.lang.String src)

setNotree

public void setNotree(java.lang.String src)

setNoindex

public void setNoindex(java.lang.String src)

setNohelp

public void setNohelp(java.lang.String src)

setNonavbar

public void setNonavbar(java.lang.String src)

setSerialwarn

public void setSerialwarn(java.lang.String src)

setStylesheetfile

public void setStylesheetfile(java.lang.String src)

setDocencoding

public void setDocencoding(java.lang.String src)

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 Exec
Following copied from class: org.apache.tools.ant.Task
Throws:
BuildException - if someting goes wrong with the build

outputLog

protected void outputLog(java.lang.String line,
                         int messageLevel)
Overrides:
outputLog in class Exec

logFlush

protected void logFlush()
Overrides:
logFlush in class Exec


Copyright © 2000 Apache Software Foundation. All Rights Reserved.