org.apache.maven.jxr

Class JXR

public class JXR extends Object

Main entry point into Maven used to kick off the XReference code building.

Version: $Id: JXR.java 360490 2006-01-01 15:07:52Z fgiust $

Author: Kevin A. Burton

Field Summary
static StringNOTICE
Description of the Field
Method Summary
StringgetDest()
Get the path to the destination files
static booleanisHtmlFile(String filename)
Check to see if the file is a HTML file
static booleanisJavaFile(String filename)
Check to see if the file is a Java source file
voidprocessPath(PackageManager packageManager, String source)
Now that we have instantiated everythign.
voidsetDest(String dest)
voidsetInputEncoding(String inputEncoding)
voidsetJavadocLinkDir(String javadocLinkDir)
voidsetLocale(Locale locale)
voidsetLog(Log log)
voidsetOutputEncoding(String outputEncoding)
voidsetRevision(String revision)
voidsetTransformer(JavaCodeTransform transformer)
voidxref(List sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom)

Field Detail

NOTICE

public static final String NOTICE
Description of the Field

Method Detail

getDest

public String getDest()
Get the path to the destination files

Returns: The path to the destination files

isHtmlFile

public static boolean isHtmlFile(String filename)
Check to see if the file is a HTML file

Parameters: filename The name of the file to check

Returns: true if the file is a HTML file

isJavaFile

public static boolean isJavaFile(String filename)
Check to see if the file is a Java source file

Parameters: filename The name of the file to check

Returns: true if the file is a Java file

processPath

public void processPath(PackageManager packageManager, String source)
Now that we have instantiated everythign. Process this JXR task.

setDest

public void setDest(String dest)

setInputEncoding

public void setInputEncoding(String inputEncoding)

setJavadocLinkDir

public void setJavadocLinkDir(String javadocLinkDir)

setLocale

public void setLocale(Locale locale)

setLog

public void setLog(Log log)

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

setRevision

public void setRevision(String revision)

setTransformer

public void setTransformer(JavaCodeTransform transformer)

xref

public void xref(List sourceDirs, String templateDir, String windowTitle, String docTitle, String bottom)
Copyright © {inceptionYear}-2008 Apache Software Foundation. All Rights Reserved.