Decorator for creating PDF Javadoc documentation.
| Task package: | com.tarsec.javadoc.pdfdoclet |
| Java package: | org.schmant.task.jdk.javadoc.pdfdoclet.ext |
| Category: | Documentation tasks |
| Since: | 0.5 |
| EntityFS-aware? | No* |
| See also: | ExtJavadocTF ExtStandardDocletDecorator |
Description:
Decorator used together with ExtJavadocTF to create PDF Javadoc documentation. It uses the PDFDoclet from http://pdfdoclet.sourceforge.net.
The decorator is configured using a property file. The file is documented on the PDFDoclet site.
Required properties
Properties
| configFile (required) | top |
The configuration file used for configurating the doclet. The file is documented on the PDFDoclet site.
Tip: If you don't want to use an external configuration file, use an inline CharSequenceReadableFile.
- Setter method:
setConfigFile(Object o)
parameters:
| docletPaths | top |
A list of classes and JAR files needed to run the doclet. The path to the PDFDoclet JAR is added automatically.
- Setter method:
addDocletPath(Object o)Add one or several files and/or directories to the doclet path.parameters:o– One or several files and/or directories to add to the doclet path.
Interpreted byInterpretAsFileStrategy.- Setter method:
addDocletPaths(Object o)Add one or several files and/or directories to the doclet path.parameters:o– One or several files and/or directories to add to the doclet path.
Interpreted byInterpretAsFileStrategy.
Examples
See ExtJavadocTF for usage examples.* That a task is not EntityFS-aware means that it is not aware of DirectoryView filters (it uses them as plain Directory:s) and also that it usually requires that the entities it takes as arguments are in a File-based file file system. (That they are ECFileResolvable.) A non File-resolvable entity can be made so by using the SchmantFileSystems.makeFileResolvable(org.entityfs.EFile) method.