xjavadoc.ant

Class XJavadocTask

public abstract class XJavadocTask extends Task

This class should be subclassed to be used for XDocletImpl, revXDoclet etc.

Author: Aslak Hellesxy Ara Abrahamian

UNKNOWN: 26. februar 2003

Field Summary
LinkedList_fileSets
XJavaDoc_xJavaDoc
Method Summary
voidaddFileset(FileSet set)
Ant's <fileset> definition.
ObjectcreateIgnoredtag()
Ignores one tag
voidexecute()
Implementation of Ant's Task#execute().
protected StringgetClasspath()
Returns the classpath
protected XJavaDocgetXJavaDoc()
voidsetDocencoding(String enc)
set generated file charset
voidsetEncoding(String enc)
set source file charset
voidsetIgnoredtags(String tags)
Sets the tags to ignore if validation is true.
voidsetValidating(boolean flag)
Sets whether or not tags will be validated.
protected abstract voidstart()
Implement this method and play with _xJavaDoc
protected voidvalidateOptions()
Validate a Xdoclet task before running it.

Field Detail

_fileSets

private final LinkedList _fileSets

_xJavaDoc

private final XJavaDoc _xJavaDoc

Method Detail

addFileset

public void addFileset(FileSet set)
Ant's <fileset> definition. To define the files to parse.

Parameters: set a fileset to add

createIgnoredtag

public Object createIgnoredtag()
Ignores one tag

Returns:

execute

public final void execute()
Implementation of Ant's Task#execute().

Throws: BuildException Ant's way of reporting build exception

getClasspath

protected String getClasspath()
Returns the classpath

Returns: the classpath

getXJavaDoc

protected XJavaDoc getXJavaDoc()

setDocencoding

public void setDocencoding(String enc)
set generated file charset

Parameters: enc the encoding

setEncoding

public void setEncoding(String enc)
set source file charset

Parameters: enc the encoding

setIgnoredtags

public void setIgnoredtags(String tags)
Sets the tags to ignore if validation is true. The value should be a comma-separated list of tag names (without the tag name)

Parameters: tags tags that should be ignored when doing validation.

setValidating

public void setValidating(boolean flag)
Sets whether or not tags will be validated.

Parameters: flag validate?

start

protected abstract void start()
Implement this method and play with _xJavaDoc

Throws: BuildException Ant's way of reporting exception

validateOptions

protected void validateOptions()
Validate a Xdoclet task before running it.

Throws: BuildException in case the validation fails.