org.jcoderz.commons.taskdefs
Class ApiDocTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.jcoderz.commons.taskdefs.ApiDocTask

All Implemented Interfaces:

Cloneable

public class ApiDocTask
extends org.apache.tools.ant.Task

Generates API documentation (DocBook format).

Author:

Michael Griffel

Field Summary

static String

NAME Task name.

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

ApiDocTask()

Method Summary

void	addSrc(SourceDirectory src) Set the source path to be used for this task run.
void	execute() Execute this task.
void	setDocletPath(org.apache.tools.ant.types.Path path) Set the doclet path to be used for this task run.
void	setFailonerror(boolean b) Set whether we should fail on an error.
void	setIn(File f) Sets the XML input file that contains the document.
void	setOut(File dir) Set the destination directory into which the result files should be copied to.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

Task name.

See Also:

Constant Field Values

Constructor Detail

ApiDocTask

public ApiDocTask()

Method Detail

setIn

public void setIn(File f)

Sets the XML input file that contains the document.

Parameters:

f - the XML input file (log message info).

setOut

public void setOut(File dir)

Set the destination directory into which the result files should be copied to. This parameter is required.

Parameters:

dir - the name of the destination directory.

setFailonerror

public void setFailonerror(boolean b)

Set whether we should fail on an error.

Parameters:

b - Whether we should fail on an error.

addSrc

public void addSrc(SourceDirectory src)

Set the source path to be used for this task run.

Parameters:

src - an Ant FileSet object containing the compilation source path.

setDocletPath

public void setDocletPath(org.apache.tools.ant.types.Path path)

Set the doclet path to be used for this task run.

Parameters:

path - an Ant Path object containing the compilation source path.

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute this task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - An building exception occurred.