|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.jxr.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:
Constructor Summary | |
---|---|
DirectoryIndexer(PackageManager packageManager,
java.lang.String root)
Constructor for the DirectoryIndexer object |
Method Summary | |
---|---|
java.lang.String |
getBottom()
see setBottom(String) |
java.lang.String |
getDocTitle()
see setDocTitle(String) |
java.lang.String |
getOutputEncoding()
see setOutputEncoding(String) |
java.lang.String |
getTemplateDir()
see setTemplateDir(String) |
java.lang.String |
getWindowTitle()
see setWindowTitle(String) |
void |
process(Log log)
Does the actual indexing. |
void |
setBottom(java.lang.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(java.lang.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(java.lang.String outputEncoding)
OutputEncoding is the encoding of output files. |
void |
setTemplateDir(java.lang.String templateDir)
TemplateDir is the location of the jelly template files used to generate the navigation pages. |
void |
setWindowTitle(java.lang.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, java.lang.String root)
packageManager
- PackageManager for this projectroot
- Path of the root output directoryMethod Detail |
public void setOutputEncoding(java.lang.String outputEncoding)
outputEncoding
- output Encodingpublic java.lang.String getOutputEncoding()
public void setTemplateDir(java.lang.String templateDir)
templateDir
- location of the template directorypublic java.lang.String getTemplateDir()
public void setWindowTitle(java.lang.String windowTitle)
windowTitle
- the <title> attributepublic java.lang.String getWindowTitle()
setWindowTitle
public void setDocTitle(java.lang.String docTitle)
docTitle
- major page headingpublic java.lang.String getDocTitle()
setDocTitle
public void setBottom(java.lang.String bottom)
bottom
- page footerpublic java.lang.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 |