net.larsan.urd.ant
Class PackageTask
java.lang.Object
|
+--org.apache.tools.ant.ProjectComponent
|
+--org.apache.tools.ant.Task
|
+--net.larsan.urd.ant.PackageTask
- public class PackageTask
- extends org.apache.tools.ant.Task
This simple task takes a text file and splits it up into multiple
package documentation files. The syntax of the text file should look
like this:
[package name] ... [/package name]
[package name] ... [/package name]
[overview] ... [/overview]
This task takes a docs file, a source directory an otional overview
directory in which case the task will look for '[overview]' in the docs file
and parse this docementation to the specified directory as an 'overview.html'
file. The required attributes are:
'docsFile' - specifying documentation file to parse
'destDir' - destination directory for the docs
The optional attribute is:
'overviewDir' - destination directory for the general overview
- Version:
- Alpha-0.1 / 2002-10-06 21:37
- Author:
- Lars J. Nilsson
| 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 |
|
Method Summary |
void |
execute()
Do execute. |
void |
setDestDir(java.io.File destDir)
Set destination directory to parse to. |
void |
setDocsFile(java.io.File docsFile)
Set documentation file to parse. |
void |
setOverviewDir(java.io.File overviewDir)
Set directory to parse general overview to. |
| 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 |
PackageTask
public PackageTask()
setDocsFile
public void setDocsFile(java.io.File docsFile)
- Set documentation file to parse. This method must be called
before execution and the argument must not be null.
setDestDir
public void setDestDir(java.io.File destDir)
- Set destination directory to parse to. This method must be called
before execution and the argument must not be null.
setOverviewDir
public void setOverviewDir(java.io.File overviewDir)
- Set directory to parse general overview to. This method is optional.
execute
public void execute()
throws org.apache.tools.ant.BuildException
- Do execute. This method throws build excetpions if the destination directory
or documentation file is not set.
- Overrides:
execute in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException