public class TLDDocGenerator extends Object
Constructor and Description |
---|
TLDDocGenerator()
Creates a new TLDDocGenerator.
|
Modifier and Type | Method and Description |
---|---|
void |
addJAR(File jar)
Adds all the tag libraries found in the given JAR.
|
void |
addTagDir(File tagdir)
Adds the given directory of tag files.
|
void |
addTagLibrary(TagLibrary tagLibrary)
Adds the given Tag Library to the list of Tag Libraries to generate
documentation for.
|
void |
addTLD(File tld)
Adds the given individual TLD file
|
void |
addWAR(File path)
Adds all the tag libraries found in the given web application
packaged as a WAR file.
|
void |
addWebApp(File path)
Adds all the tag libraries found in the given web application.
|
void |
generate()
Commences documentation generation.
|
void |
setDocTitle(String title)
Sets the title for the TLD index (first) page.
|
void |
setOutputDirectory(File dir)
Sets the output directory for generated files.
|
void |
setQuiet(boolean quiet)
Sets quiet mode (produce no stdout during generation)
|
void |
setWindowTitle(String title)
Sets the browser window title for the documentation
|
void |
setXSLTDirectory(File dir)
Sets the directory from which to obtain the XSLT stylesheets.
|
public void addTagLibrary(TagLibrary tagLibrary)
tagLibrary
- The tag library to add.public void addTLD(File tld)
tld
- The TLD file to addpublic void addWebApp(File path)
path
- The path to the root of the web application.public void addJAR(File jar)
jar
- The JAR file to add.public void addWAR(File path)
war
- The war containing the web applicationpublic void addTagDir(File tagdir)
tld
- The tag directory to addpublic void setXSLTDirectory(File dir)
dir
- The base directory for the stylesheetspublic void setOutputDirectory(File dir)
dir
- The base directory for generated files.public void setWindowTitle(String title)
title
- The browser window titlepublic void setDocTitle(String title)
title
- The title for the TLD indexpublic void setQuiet(boolean quiet)
quiet
- True if no output is to be produced, false otherwise.public void generate() throws GeneratorException, TransformerException
Copyright © 2003–2015 sun. All rights reserved.