|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.tlddoc.TLDDocGenerator
public class TLDDocGenerator
TLDDoc Generator. Takes a set of TLD files and generates a set of javadoc-style HTML pages that describe the various components of the input tag libraries.
Constructor Summary | |
---|---|
TLDDocGenerator()
Creates a new TLDDocGenerator. |
Method Summary | |
---|---|
void |
addJAR(java.io.File jar)
Adds all the tag libraries found in the given JAR. |
void |
addTagDir(java.io.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(java.io.File tld)
Adds the given individual TLD file |
void |
addWAR(java.io.File path)
Adds all the tag libraries found in the given web application packaged as a WAR file. |
void |
addWebApp(java.io.File path)
Adds all the tag libraries found in the given web application. |
void |
generate()
Commences documentation generation. |
void |
setDocTitle(java.lang.String title)
Sets the title for the TLD index (first) page. |
void |
setOutputDirectory(java.io.File dir)
Sets the output directory for generated files. |
void |
setQuiet(boolean quiet)
Sets quiet mode (produce no stdout during generation) |
void |
setWindowTitle(java.lang.String title)
Sets the browser window title for the documentation |
void |
setXSLTDirectory(java.io.File dir)
Sets the directory from which to obtain the XSLT stylesheets. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TLDDocGenerator()
Method Detail |
---|
public void addTagLibrary(TagLibrary tagLibrary)
tagLibrary
- The tag library to add.public void addTLD(java.io.File tld)
tld
- The TLD file to addpublic void addWebApp(java.io.File path)
path
- The path to the root of the web application.public void addJAR(java.io.File jar)
jar
- The JAR file to add.public void addWAR(java.io.File path)
war
- The war containing the web applicationpublic void addTagDir(java.io.File tagdir)
tld
- The tag directory to addpublic void setXSLTDirectory(java.io.File dir)
dir
- The base directory for the stylesheetspublic void setOutputDirectory(java.io.File dir)
dir
- The base directory for generated files.public void setWindowTitle(java.lang.String title)
title
- The browser window titlepublic void setDocTitle(java.lang.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, javax.xml.transform.TransformerException
GeneratorException
javax.xml.transform.TransformerException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |