org.apache.maven.jxr
public class DirectoryIndexer extends Object
Version: $Id: DirectoryIndexer.java 360490 2006-01-01 15:07:52Z fgiust $
Constructor Summary | |
---|---|
DirectoryIndexer(PackageManager packageManager, String root)
Constructor for the DirectoryIndexer object
|
Method Summary | |
---|---|
String | getBottom()
see setBottom(String)
|
String | getDocTitle()
see setDocTitle(String)
|
String | getOutputEncoding()
see setOutputEncoding(String) |
String | getTemplateDir()
see setTemplateDir(String) |
String | getWindowTitle()
see setWindowTitle(String)
|
void | process(Log log)
Does the actual indexing.
|
void | setBottom(String bottom)
Bottom is a footer for the navigation pages, usually a copyright
see the javadoc documentation for the property of the same name
|
void | setDocTitle(String docTitle)
DocTitle is used as a page heading for the summary files
see the javadoc documentation for the property of the same name
|
void | setOutputEncoding(String outputEncoding)
OutputEncoding is the encoding of output files.
|
void | setTemplateDir(String templateDir)
TemplateDir is the location of the jelly template files used
to generate the navigation pages.
|
void | setWindowTitle(String windowTitle)
WindowTitle is used in the output's <title> tags
see the javadoc documentation for the property of the same name
|
Parameters: packageManager PackageManager for this project root Path of the root output directory
See Also: setBottom
See Also: setDocTitle
See Also: setWindowTitle
Throws: JxrException If something went wrong
Parameters: bottom page footer
Parameters: docTitle major page heading
Parameters: outputEncoding output Encoding
Parameters: templateDir location of the template directory
Parameters: windowTitle the <title> attribute