|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.jxr.DirectoryIndexer
public class DirectoryIndexer
This class creates the navigational pages for jxr's cross-referenced source files. The navigation is inspired by javadoc, so it should have a familiar feel. Creates the following files:
index.html
main index containing the framesetoverview-frame.html
list of the project's packages (top left)allclasses-frame.html
list of all classes in the project (bottom left)overview-summary.html
top-level listing of the project's packages (main frame)package-summary.html
listing of all classes in this package (main frame)package-frame.html
listing of all classes in this package (bottom left)
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DirectoryIndexer(PackageManager packageManager, String root)
packageManager
- PackageManager for this projectroot
- Path of the root output directoryMethod Detail |
---|
public void setOutputEncoding(String outputEncoding)
outputEncoding
- output Encodingpublic String getOutputEncoding()
public void setTemplateDir(String templateDir)
templateDir
- location of the template directorypublic String getTemplateDir()
public void setWindowTitle(String windowTitle)
windowTitle
- the <title> attributepublic String getWindowTitle()
setWindowTitle
public void setDocTitle(String docTitle)
docTitle
- major page headingpublic String getDocTitle()
setDocTitle
public void setBottom(String bottom)
bottom
- page footerpublic String getBottom()
setBottom
public void process(Log log) throws JxrException
JxrException
- If something went wrong
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |