|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.jxr.JXR
public class JXR
Main entry point into Maven used to kick off the XReference code building.
Field Summary | |
---|---|
static java.lang.String |
NOTICE
Description of the Notice. |
Constructor Summary | |
---|---|
JXR()
|
Method Summary | |
---|---|
java.lang.String |
getDest()
Get the path to the destination files. |
static boolean |
isHtmlFile(java.lang.String filename)
Check to see if the file is an HTML file. |
static boolean |
isJavaFile(java.lang.String filename)
Check to see if the file is a Java source file. |
void |
processPath(PackageManager packageManager,
java.lang.String source)
Now that we have instantiated everything. |
void |
setDest(java.lang.String dest)
|
void |
setExcludes(java.lang.String[] excludes)
|
void |
setIncludes(java.lang.String[] includes)
|
void |
setInputEncoding(java.lang.String inputEncoding)
|
void |
setJavadocLinkDir(java.lang.String javadocLinkDir)
|
void |
setLocale(java.util.Locale locale)
|
void |
setLog(Log log)
|
void |
setOutputEncoding(java.lang.String outputEncoding)
|
void |
setRevision(java.lang.String revision)
|
void |
setTransformer(JavaCodeTransform transformer)
|
void |
xref(java.util.List sourceDirs,
java.lang.String templateDir,
java.lang.String windowTitle,
java.lang.String docTitle,
java.lang.String bottom)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NOTICE
Constructor Detail |
---|
public JXR()
Method Detail |
---|
public void processPath(PackageManager packageManager, java.lang.String source) throws java.io.IOException
packageManager
- source
-
java.io.IOException
public static boolean isJavaFile(java.lang.String filename)
filename
- The name of the file to check
true if the file is a Java file
public static boolean isHtmlFile(java.lang.String filename)
filename
- The name of the file to check
true if the file is an HTML file
public java.lang.String getDest()
public void setDest(java.lang.String dest)
dest
- public void setLocale(java.util.Locale locale)
locale
- public void setInputEncoding(java.lang.String inputEncoding)
inputEncoding
- public void setOutputEncoding(java.lang.String outputEncoding)
outputEncoding
- public void setJavadocLinkDir(java.lang.String javadocLinkDir)
javadocLinkDir
- public void setTransformer(JavaCodeTransform transformer)
transformer
- public void setRevision(java.lang.String revision)
revision
- public void setLog(Log log)
log
- public void xref(java.util.List sourceDirs, java.lang.String templateDir, java.lang.String windowTitle, java.lang.String docTitle, java.lang.String bottom) throws java.io.IOException, JxrException
sourceDirs
- templateDir
- windowTitle
- docTitle
- bottom
-
java.io.IOException
JxrException
public void setExcludes(java.lang.String[] excludes)
public void setIncludes(java.lang.String[] includes)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |