This executes the apache Stylebook documentation generator. -Unlike the commandline version of this tool, all three arguments -are required to run stylebook.
-Note: This task depends on external libraries not included in the Ant distribution. -See Library Dependencies for more information.
-
- 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.
-
| Attribute | -Description | -Required | -
| book | -the book xml file that the documentation generation starts from - | -Yes | -
| skindirectory | -the directory that contains the stylebook skin - | -Yes | -
| targetdirectory | -the destination directory where the documentation is generated - | -Yes | -
-The user can also specify the nested <classpath> element which defines classpath
-in which the task is executed.
--The above will generate documentation in build/docs starting from the book -src/xdocs/book.xml and using the skin located in directory src/skins/myskin. - - - - - - diff --git a/docs/manual/install.html b/docs/manual/install.html index 3f731cdb9..18a719c3e 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -722,11 +722,6 @@ you need jakarta-oro 2.0.8 or later, and commons-net<-<stylebook targetdirectory="build/docs" - book="src/xdocs/book.xml" - skindirectory="src/skins/myskin"/> --
Executes the Apache Stylebook documentation generator. - Unlike the command-line version of this tool, all three arguments - are required to run the Stylebook task.
- * 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. - * @todo stop extending from Java. - * @deprecated since 1.7. - * This task is considered unsupported by the Ant developers - */ -public class StyleBook extends Java { - // CheckStyle:VisibilityModifier OFF - bc - // CheckStyle:MemberNameCheck OFF - bc - protected File m_targetDirectory; - protected File m_skinDirectory; - protected String m_loaderConfig; - protected File m_book; - // CheckStyle:MemberNameCheck ON - // CheckStyle:VisibilityModifier ON - - - /** - * Constructor - */ - public StyleBook() { - setClassname("org.apache.stylebook.StyleBook"); - setFork(true); - setFailonerror(true); - } - - /** - * Set the book xml file that the documentation generation starts from; - * required. - * @param book the source file - */ - - public void setBook(final File book) { - m_book = book; - } - - - /** - * Set the directory that contains the stylebook skin; - * required. - * @param skinDirectory the location of the stylebook skin - */ - public void setSkinDirectory(final File skinDirectory) { - m_skinDirectory = skinDirectory; - } - - - /** - * Set the destination directory where the documentation is generated; - * required. - * @param targetDirectory the document output directory - */ - public void setTargetDirectory(final File targetDirectory) { - m_targetDirectory = targetDirectory; - } - - /** - * A loader configuration to send to stylebook; optional. - * @param loaderConfig the configuration to use. - */ - public void setLoaderConfig(final String loaderConfig) { - m_loaderConfig = loaderConfig; - } - - - /** - * call the program - * @throws BuildException if there is a problem. - */ - public void execute() - throws BuildException { - - if (null == m_targetDirectory) { - throw new BuildException("TargetDirectory attribute not set."); - } - - if (null == m_skinDirectory) { - throw new BuildException("SkinDirectory attribute not set."); - } - - if (null == m_book) { - throw new BuildException("book attribute not set."); - } - - createArg().setValue("targetDirectory=" + m_targetDirectory); - createArg().setValue(m_book.toString()); - createArg().setValue(m_skinDirectory.toString()); - if (null != m_loaderConfig) { - createArg().setValue("loaderConfig=" + m_loaderConfig); - } - - super.execute(); - } -}