xjavadoc.ant

Class XJavadocTask


public abstract class XJavadocTask
extends Task

This class should be subclassed to be used for XDocletImpl, revXDoclet etc.
Authors:
Aslak Helles?y
Ara Abrahamian

Field Summary

private LinkedList
_fileSets
private XJavaDoc
_xJavaDoc

Method Summary

void
addFileset(FileSet set)
Ant's <fileset> definition.
Object
createIgnoredtag()
Ignores one tag
void
execute()
Implementation of Ant's Task.execute().
protected String
getClasspath()
Returns the classpath
protected XJavaDoc
getXJavaDoc()
void
setDocencoding(String enc)
set generated file charset
void
setEncoding(String enc)
set source file charset
void
setIgnoredtags(String tags)
Sets the tags to ignore if validation is true.
void
setValidating(boolean flag)
Sets whether or not tags will be validated.
protected abstract void
start()
Implement this method and play with _xJavaDoc
protected void
validateOptions()
Validate a Xdoclet task before running it.

Field Details

_fileSets

private final LinkedList _fileSets

_xJavaDoc

private final XJavaDoc _xJavaDoc

Method Details

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()
            throws BuildException
Implementation of Ant's Task.execute().

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()
            throws BuildException
Implement this method and play with _xJavaDoc

validateOptions

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