|
||||||||||
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 String |
NOTICE
Description of the Notice. |
Constructor Summary | |
---|---|
JXR()
|
Method Summary | |
---|---|
String |
getDest()
Get the path to the destination files. |
static boolean |
isHtmlFile(String filename)
Check to see if the file is an HTML file. |
static boolean |
isJavaFile(String filename)
Check to see if the file is a Java source file. |
void |
processPath(PackageManager packageManager,
String source)
Now that we have instantiated everything. |
void |
setDest(String dest)
|
void |
setExcludes(String[] excludes)
|
void |
setIncludes(String[] includes)
|
void |
setInputEncoding(String inputEncoding)
|
void |
setJavadocLinkDir(String javadocLinkDir)
|
void |
setLocale(Locale locale)
|
void |
setLog(Log log)
|
void |
setOutputEncoding(String outputEncoding)
|
void |
setRevision(String revision)
|
void |
setTransformer(JavaCodeTransform transformer)
|
void |
xref(List sourceDirs,
String templateDir,
String windowTitle,
String docTitle,
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 String NOTICE
Constructor Detail |
---|
public JXR()
Method Detail |
---|
public void processPath(PackageManager packageManager, String source) throws IOException
packageManager
- source
-
IOException
public static boolean isJavaFile(String filename)
filename
- The name of the file to check
true if the file is a Java file
public static boolean isHtmlFile(String filename)
filename
- The name of the file to check
true if the file is an HTML file
public String getDest()
public void setDest(String dest)
dest
- public void setLocale(Locale locale)
locale
- public void setInputEncoding(String inputEncoding)
inputEncoding
- public void setOutputEncoding(String outputEncoding)
outputEncoding
- public void setJavadocLinkDir(String javadocLinkDir)
javadocLinkDir
- public void setTransformer(JavaCodeTransform transformer)
transformer
- public void setRevision(String revision)
revision
- public void setLog(Log log)
log
- public void xref(List sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom) throws IOException, JxrException
sourceDirs
- templateDir
- windowTitle
- docTitle
- bottom
-
IOException
JxrException
public void setExcludes(String[] excludes)
public void setIncludes(String[] includes)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |