Build task reference documentation for one or several task packages.
| Task package: | org.schmant.task.taskpackage |
| Java package: | org.schmant.task.tp.taskref |
| Category: | Documentation tasks |
| Since: | 0.8 |
| EntityFS-aware? | Yes* |
| Implements: | ActionTaskFactory GeneratorTaskFactory ProcessTaskFactory |
Description:
Build task reference documentation for one or several task packages. This task looks for task reference documentation XML files in its source directory hierarchies and builds task reference documentation from them.
Each task package has one task reference XML document per task and one
overview.xml that contains overview documentation for the task
package. The format of task reference documents is specified by the
tfdoc-1.2.dtd DTD. The format
of the overview file is specified by the
tpdoc-1.0.dtd DTD.
After running this task, run ApiLinksTF on the generated files.
Required properties
Properties
| documentBuilderFactoryClassName | top |
The fully qualified class name of the DocumentBuilderFactory implementation to use for parsing the task reference source files.
- Setter method:
setDocumentBuilderFactoryClassName(String fcn)
parameters:fcn– The name of the implementation class.- Default value:
null(Use the factory implementation returned by java.xml.parser.DocumentBuilderFactory's lookup mechanism.)
| inputEncoding | top |
The character encoding of the input file. Use this if the input file has a non-standard encoding, i.e. an encoding different from the Java virtual machine's (platform dependent) default charset.
- Setter method:
setInputEncoding(Charset c)
parameters:c– The input charset.- Setter method:
setInputEncoding(String s)
parameters:s– The name of a character encoding.- Default value:
- The platform's default encoding.
| logFooter | top |
The message that is logged to info level
after the task has been successfully run.
- Setter method:
setLogFooter(String s)
parameters:s– The footer message.- Default value:
- Empty (no footer message is logged.)
- See also:
- logHeader
| logHeader | top |
The message that is logged to info level
before the task is run.
- Setter method:
setLogHeader(String s)
parameters:s– The header message.- Default value:
- A task class specific message.
- See also:
- logFooter
| outputEncoding | top |
The character encoding of the output file. Use this if the output file should have a non-standard encoding, i.e. an encoding different from the Java virtual machine's (platform dependent) default charset.
- Setter method:
setOutputEncoding(Charset c)
parameters:c– The output charset.- Setter method:
setOutputEncoding(String s)
parameters:s– The name of a character encoding.- Default value:
- The platform's default encoding.
- See also:
- target
| overwriteStrategy | top |
The overwrite strategy decides how the task will react if there already is an entity (file or directory) in a location where it wants to create a new entity.
If the strategy is to not overwrite existing entities, the task will fail when it cannot create the entities that it wants to create.
Non-empty directories are never overwritten, regardless of the chosen strategy.
- Setter method:
setOverwrite(boolean b)Setting this to a value ofparameters:truemeans that the DoOverwriteAndLogWarning strategy is used. A value of false gives the DontOverwriteAndThrowException strategy.b– Should an existing entity be overwritten?- Setter method:
setOverwriteStrategy(OverwriteStrategy strat)Set the overwrite strategy.parameters:strat– The overwrite strategy.- Default value:
- DontOverwriteAndThrowException
- See also:
- target
| reportLevel | top |
This property is used to change the Report level for all task created by this task factory. The report level is changed for the thread running the task when the it is run, and is restored to its previous level when the it is done.
- Setter method:
setReportLevel(Level l)Set the report levelparameters:l– The new report level.
| sources (required) | top |
Root directories for the directory hierarchies that contain the task reference source files.
- Setter method:
addSource(Object o)Add one or several source directories.parameters:o– One or several source directories.
Interpreted bySchmantTaskrefTask.interpretSources(java.util.List).- Setter method:
addSources(Object o)Add one or several source directories.parameters:o– One or several source directories.
Interpreted bySchmantTaskrefTask.interpretSources(java.util.List).- Setter method:
clearSources()Discard all source directories.- Setter method:
setSource(Object o)Set one or several source directories, discarding previously set sources.parameters:o– One or several source directories.
Interpreted bySchmantTaskrefTask.interpretSources(java.util.List).- Setter method:
setSources(Object o)Set one or several source directories, discarding previously set sources.parameters:o– One or several source directories.
Interpreted bySchmantTaskrefTask.interpretSources(java.util.List).
| target (required) | top |
The target directory where the task reference documentation will be put.
- Setter method:
setTarget(Object o)Set the target.parameters:
| taskCategories | top |
The available task categories, such as I/O tasks or XML tasks.
- Setter method:
addTaskCategories(Object o)Add one or several task categories.parameters:- Setter method:
addTaskCategory(TaskCategory cat)Add one task categoryparameters:cat– The task category.- Setter method:
clearTaskCategories()Clear the set of available task categories.- Setter method:
setTaskCategories(Object o)Set one or several task categories, discarding previously set categories.parameters:- Default value:
- The following task categories:
catAnalyze– Analyzing tasks such as the ExtFindbugsTF.catArchive– Archiving tasks such as the TarTF.catCompile– Compiling tasks such as the Jdk6JavacTF.catDoc– Documentation tasks such as the ExtJavadocTF.catExec– Program execution tasks such as the ExtProcessTF.catHtml– HTML tasks such as the HtmlLinkValidationTF.catIO– I/O tasks such as the TreeCopyTF.catMeta– Meta-tasks such as the RecursiveActionTF.catScm– Source code management tasks such as the SvnExportTF.catTest– Test tasks such as the JUnit4TF.catText– Text manipulation tasks such as the TextReplaceTF.catUnix– Unix tasks such as the ChmodTF.catXml– XML tasks such as the XsltTF.
| traceLogging | top |
If trace logging is enabled for a task, it reports its configuration before it is run.
Trace logging may also be enabled globally for all tasks by calling TraceMode.setTraceMode(boolean).
- Setter method:
setTraceLogging(boolean b)Enable or disable trace logging.parameters:b– Enable trace logging?
| transformerFactoryClassName | top |
The fully qualified name of the TransformerFactory object to use for creating XSL transformers.
- Setter method:
setTransformerFactoryClassName(String n)
parameters:n– The fully qualified class name of the transformer factory implementation.- Default value:
org.apache.xalan.processor.TransformerFactoryImpl(the transformer factory from Apache Xalan).
| urlForApiDocumentation | top |
The Internet address of the Schmant API documentation.
- Setter method:
setUrlForApiDocumentation(String l)
parameters:l– The URL.- Default value:
http://schmant.sourceforge.net/releases/current/api/index.html
| urlForStylesheet | top |
The address of the CSS stylesheet to use in the documentation.
- Setter method:
setUrlForStylesheet(String l)
parameters:l– The URL.- Default value:
schmant_taskref.css
Examples
No examples. See the Task Author's Guide.* An EntityFS-aware task is implemented using EntityFS. This means that it uses the filter settings of DirectoryView:s and also that it often can work with other file system implementations than File-based, such as the RAM file system.