org.apache.tools.ant.taskdefs.optional
Class StyleBook
- Cloneable
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.
- stop extending from Java.
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.
|
addAssertions , addConfiguredRedirector , addEnv , addSysproperty , addSyspropertyset , clearArgs , createArg , createBootclasspath , createClasspath , createJvmarg , createPermissions , createWatchdog , execute , executeJava , getCommandLine , getSysProperties , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , maybeSetResultPropertyValue , run , setAppend , setArgs , setClassname , setClasspath , setClasspathRef , setCloneVm , setDir , setError , setErrorProperty , setFailonerror , setFork , setInput , setInputString , setJVMVersion , setJar , setJvm , setJvmargs , setLogError , setMaxmemory , setNewenvironment , setOutput , setOutputproperty , setResultProperty , setSpawn , setTimeout , setupRedirector |
bindToOwner , execute , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , log , log , maybeConfigure , perform , reconfigure , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
m_book
protected File m_book
m_loaderConfig
protected String m_loaderConfig
m_skinDirectory
protected File m_skinDirectory
m_targetDirectory
protected File m_targetDirectory
StyleBook
public StyleBook()
Constructor
setBook
public void setBook(File book)
Set the book xml file that the documentation generation starts from;
required.
setLoaderConfig
public void setLoaderConfig(String loaderConfig)
A loader configuration to send to stylebook; optional.
loaderConfig
- the configuration to use.
setSkinDirectory
public void setSkinDirectory(File skinDirectory)
Set the directory that contains the stylebook skin;
required.
skinDirectory
- the location of the stylebook skin
setTargetDirectory
public void setTargetDirectory(File targetDirectory)
Set the destination directory where the documentation is generated;
required.
targetDirectory
- the document output directory