org.apache.tools.ant.taskdefs.optional

Class StyleBook

public class StyleBook extends Java

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 Filem_book
protected Stringm_loaderConfig
protected Filem_skinDirectory
protected Filem_targetDirectory
Constructor Summary
StyleBook()
Method Summary
voidexecute()
call the program
voidsetBook(File book)
The book xml file that the documentation generation starts from; required.
voidsetLoaderConfig(String loaderConfig)
A loader configuration to send to stylebook; optional.
voidsetSkinDirectory(File skinDirectory)
the directory that contains the stylebook skin; required.
voidsetTargetDirectory(File targetDirectory)
the destination directory where the documentation is generated; required.

Field Detail

m_book

protected File m_book

m_loaderConfig

protected String m_loaderConfig

m_skinDirectory

protected File m_skinDirectory

m_targetDirectory

protected File m_targetDirectory

Constructor Detail

StyleBook

public StyleBook()

Method Detail

execute

public void execute()
call the program

setBook

public void setBook(File book)
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.

setSkinDirectory

public void setSkinDirectory(File skinDirectory)
the directory that contains the stylebook skin; required.

setTargetDirectory

public void setTargetDirectory(File targetDirectory)
the destination directory where the documentation is generated; required.
Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.