org.apache.tools.ant.taskdefs.optional
public class StyleBook extends Java
Deprecated: since 1.7. This task is considered unsupported by the Ant developers
Executes the Apache Stylebook documentation generator. Unlike the commandline version of this tool, all three arguments are required to run stylebook.Being extended from <Java>, all the parent's attributes and options are available. Do not set any apart from the classpath as they are not guaranteed to be there in future.
UNKNOWN: stop extending from Java.
Field Summary | |
---|---|
protected File | m_book |
protected String | m_loaderConfig |
protected File | m_skinDirectory |
protected File | m_targetDirectory |
Constructor Summary | |
---|---|
StyleBook()
Constructor |
Method Summary | |
---|---|
void | execute()
call the program |
void | setBook(File book)
Set the book xml file that the documentation generation starts from;
required. |
void | setLoaderConfig(String loaderConfig)
A loader configuration to send to stylebook; optional. |
void | setSkinDirectory(File skinDirectory)
Set the directory that contains the stylebook skin;
required. |
void | setTargetDirectory(File targetDirectory)
Set the destination directory where the documentation is generated;
required. |
Throws: BuildException if there is a problem.
Parameters: book the source file
Parameters: loaderConfig the configuration to use.
Parameters: skinDirectory the location of the stylebook skin
Parameters: targetDirectory the document output directory