|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.jxr.JxrBean
public class JxrBean
Creates an html-based, cross referenced version of Java source code for a project.
Constructor Summary | |
---|---|
JxrBean()
Default constructor |
Method Summary | |
---|---|
void |
addSourceDir(String sourceDir)
Adds a directory to the list of those to be cross-referenced. |
String |
getBottom()
see DirectoryIndexer |
String |
getDestDir()
see setDestDir(String) |
String |
getDocTitle()
see DirectoryIndexer |
String |
getInputEncoding()
see setInputEncoding(String) |
String |
getJavadocDir()
see setJavadocDir(String) |
Locale |
getLocale()
Returns the locale. |
String |
getOutputEncoding()
see setOutputEncoding(String) |
String |
getTemplateDir()
see setTemplateDir(String) |
String |
getWindowTitle()
see DirectoryIndexer |
void |
setBottom(String newBottom)
see DirectoryIndexer |
void |
setDestDir(String newDestDir)
DestDir is the directory in which jxr will write its output |
void |
setDocTitle(String newDocTitle)
see DirectoryIndexer |
void |
setInputEncoding(String newInputEncoding)
InputEncoding is the encoding of source files. |
void |
setJavadocDir(String newJavadocDir)
JavadocDir is used to cross-reference the source code with the appropriate javadoc pages. |
void |
setLocale(Locale newLocale)
Sets the locale. |
void |
setOutputEncoding(String newOutputEncoding)
OutputEncoding is the encoding of output files. |
void |
setSourceDir(String sourceDir)
Sets a single source directory to be cross-referenced. |
void |
setSourceDirs(List newSourceDirs)
Sets a list of source directories to be cross-referenced. |
void |
setTemplateDir(String newTemplateDir)
TemplateDir is where the navigation templates are located |
void |
setWindowTitle(String newWindowTitle)
see DirectoryIndexer |
void |
xref()
Starts the cross-referencing and indexing. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JxrBean()
Method Detail |
---|
public void xref() throws org.apache.maven.jxr.JxrException
JxrException
- JxrExceptionpublic void setSourceDirs(List newSourceDirs)
newSourceDirs
- The list of source directories.public void setSourceDir(String sourceDir)
sourceDir
- The source directory to be cross-referenced.public void addSourceDir(String sourceDir)
sourceDir
- The source directory to be cross-referenced.public void setDestDir(String newDestDir)
newDestDir
- the destination directory for jxr outputpublic String getDestDir()
public Locale getLocale()
public void setLocale(Locale newLocale)
newLocale
- the locale.public void setInputEncoding(String newInputEncoding)
newInputEncoding
- encoding of source filespublic String getInputEncoding()
public void setOutputEncoding(String newOutputEncoding)
newOutputEncoding
- encoding of output filespublic String getOutputEncoding()
public void setJavadocDir(String newJavadocDir)
null
, no javadoc link will be added.
newJavadocDir
- The root directory containing javadocspublic String getJavadocDir()
public void setWindowTitle(String newWindowTitle)
newWindowTitle
- used by DirectoryIndexersetWindowTitle(String)
public String getWindowTitle()
setWindowTitle(String)
public void setDocTitle(String newDocTitle)
newDocTitle
- used by DirectoryIndexersetDocTitle(String)
public String getDocTitle()
setDocTitle(String)
public void setBottom(String newBottom)
newBottom
- used by DirectoryIndexersetBottom(String)
public String getBottom()
setBottom(String)
public void setTemplateDir(String newTemplateDir)
newTemplateDir
- the template directorypublic String getTemplateDir()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |