org.knopflerfish.ant.taskdefs.bundle
Class ExtraBundleDocTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.knopflerfish.ant.taskdefs.bundle.ExtraBundleDocTask
- All Implemented Interfaces:
- java.lang.Cloneable
- public class ExtraBundleDocTask
- extends org.apache.tools.ant.Task
This task is currently used in conjunction with MakeHTMLTask, which
is used to create the htdocs directory in the Knopflerfish
distribtions.
The task is used to create extra documentation of bundles. The task
is given a set of files it searches them for documentation, and
generates a index-file that links to these sites.
Attribute |
Description |
Required |
outdir
|
Directory where the task copies the directories
|
Yes
|
The task includes the directories that contains an index.html
,
others are not included.
If a directory contains an index.html
and doc.properties
the task will read the doc.properties
file.
The properties used are Title
and Description
. These
properties will be used when creating the main index site.
If the directory does not contain any doc.properties
the task
will attempt to create a valid link 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 |
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 |
ExtraBundleDocTask
public ExtraBundleDocTask()
setOut
public void setOut(java.lang.String s)
setTemplate
public void setTemplate(java.lang.String template)
setPattern
public void setPattern(java.lang.String pattern)
addFileset
public void addFileset(org.apache.tools.ant.types.FileSet set)
execute
public void execute()