Package org.java.plugin.tools.ant
Class DocTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.java.plugin.tools.ant.BaseJpfTask
org.java.plugin.tools.ant.DocTask
- All Implemented Interfaces:
Cloneable
,org.apache.tools.ant.types.selectors.SelectorContainer
The Ant task to generate documentation from plug-in manifest.
- Version:
- $Id$
-
Field Summary
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
void
setDestDir
(File aDestDir) void
setDocEncoding
(String anEncoding) void
setEncoding
(String anEncoding) void
setOverview
(File anOverviewFile) void
setStylesheetFile
(File aStylesheetFile) void
setTemplates
(String aTemplatesPath) Methods inherited from class org.java.plugin.tools.ant.BaseJpfTask
addFileset, getBlackList, getIncludedFiles, getManifestURL, getPathResolver, getRegistry, getVerbose, getWhiteList, initRegistry, isManifestAccepted, loadList, setBaseDir, setBlackList, setVerbose, setWhiteList
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
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
-
Constructor Details
-
DocTask
public DocTask()
-
-
Method Details
-
setDestDir
- Parameters:
aDestDir
- base directory for generated documentation files
-
setOverview
- Parameters:
anOverviewFile
- documentation overview HTML file
-
setEncoding
- Parameters:
anEncoding
- source files encoding name (templates, overview etc.)
-
setDocEncoding
- Parameters:
anEncoding
- output files encoding name
-
setStylesheetFile
- Parameters:
aStylesheetFile
- CSS style sheet to use
-
setTemplates
- Parameters:
aTemplatesPath
- path to template files (should be available in classpath)
-
execute
public void execute()- Overrides:
execute
in classorg.apache.tools.ant.Task
- See Also:
-