org.knopflerfish.ant.taskdefs.bundle
Class BundleHTMLExtractorTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.knopflerfish.ant.taskdefs.bundle.BundleHTMLExtractorTask
- All Implemented Interfaces:
- java.lang.Cloneable
- public class BundleHTMLExtractorTask
- extends org.apache.tools.ant.Task
Task that analyzes a set of bundle jar files and builds HTML documentation
from these bundles. Also creates cross-references to bundle dependencies.
All generated HTML will be stored in the same directory structure as
the scanned jars, e.g a jar file
baseDir/log/log-api.jar
will have a corresponding
outDir/log/log-api.html
in the directory specified with the attribute outDir
.
The part of the original bundle jar path to remove when creating
the output directory structure in outDir
is specified
by the baseDir
attribute.
Bundle jar files files are analyzed using the static manifest attributes.
Parameters
Attribute |
Description |
Required |
javadocRelPath |
Relative path (from outDir) to javadocs.
|
No. Default value is "." |
outDir |
Directory to place resulting files in.
|
No. Default value is "." |
baseDir |
Remove this part of the path from the specified jar-files and
use the remainder as file name in the outDir.
|
No. Default value is "" |
templateHTMLDir |
Directory containing HTML template files. This directory must
contain the files:
bundle_index.html
bundle_list.html
bundle_main.html
style.css
|
No. Default value is "." |
systemPackageSet |
Comma-separated set of packages which are system packages and
thus globally available.
These are not cross-referenced.
|
No.
Default value is javax.swing, javax.accessibility,
javax.servlet, javax.xml,org.xml, org.w3c, java, com.sun
|
skipAttribSet |
Comma-separated set of manifest attributes which shouldn't be printed.
|
No.
Default value is Manifest-Version, Ant-Version,
Bundle-Config, Created-By, Built-From
|
includeSourceFiles |
Controls if Java source files shall be copied and linked into
the HTML structure.
|
No.
Default value "False"
|
listHeader |
Heading to print at the top of the bundle list in the left frame
of the page.
|
No. Default value is "" |
Parameters specified as nested elements
fileset
(required)
All jar files must be specified as a fileset. No jar files
are ignored.
Examples
<bundlehtml templateHTMLDir = "${ant.dir}/html_template"
outDir = "${release.dir}/docs"
baseDir = "${release.dir}/osgi"
javadocRelPath = "../javadoc"
>
<fileset dir="${release.dir}/osgi/jars">
<include name = "**/*.jar"/>
</fileset>
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 |
BundleHTMLExtractorTask
public BundleHTMLExtractorTask()
setCheckJavaDoc
public void setCheckJavaDoc(java.lang.String s)
setTemplateHTMLDir
public void setTemplateHTMLDir(java.lang.String s)
setIncludeSourceFiles
public void setIncludeSourceFiles(java.lang.String s)
setOutDir
public void setOutDir(java.lang.String s)
setBaseDir
public void setBaseDir(java.lang.String s)
setJavadocRelPath
public void setJavadocRelPath(java.lang.String s)
addFileset
public void addFileset(org.apache.tools.ant.types.FileSet set)
setListProps
public void setListProps(java.lang.String s)
setAlwaysProps
public void setAlwaysProps(java.lang.String s)
setSkipAttribSet
public void setSkipAttribSet(java.lang.String s)
setSystemPackageSet
public void setSystemPackageSet(java.lang.String s)
setListHeader
public void setListHeader(java.lang.String s)
execute
public void execute()
throws org.apache.tools.ant.BuildException
- Throws:
org.apache.tools.ant.BuildException