JavaDoq 1.0 API

com.javadoq
Class JavaDoqTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by com.javadoq.JavaDoqTask
All Implemented Interfaces:
java.lang.Cloneable

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

A task for an Ant builder to run JavaDoq.

Author:
J.J.Liu (Jianjun Liu) at http://www.javadoq.com

Field Summary
 
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
JavaDoqTask()
           
 
Method Summary
 void execute()
          Executes the task.
 void setDestination(java.io.File dst)
          Sets target document directory for JavaDoq.
 void setSource(java.io.File src)
          Sets source code directory for JavaDoq.
 void setTitle(java.lang.String title)
          Sets title for JavaDoq.
 
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
 

Constructor Detail

JavaDoqTask

public JavaDoqTask()
Method Detail

execute

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

Executes the task.

Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException
Since:
1.0

setSource

public void setSource(java.io.File src)

Sets source code directory for JavaDoq.

Parameters:
src - The directory file of the source code.
Since:
1.0

setDestination

public void setDestination(java.io.File dst)

Sets target document directory for JavaDoq.

Parameters:
dst - The directory file for the target documents.
Since:
1.0

setTitle

public void setTitle(java.lang.String title)

Sets title for JavaDoq.

Parameters:
title - The title for the target documents.
Since:
1.0

JavaDoq 1.0 API

Copyright © 2008-2011 J.J.Liu (www.javadoq.com). All Rights Reserved.