org.apache.tools.ant.taskdefs.optional.javacc

Class JJDoc

Implemented Interfaces:
Cloneable

public class JJDoc
extends Task

Runs the JJDoc compiler compiler.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

JJDoc()
Constructor

Method Summary

void
execute()
Do the task.
void
setJavacchome(File javaccHome)
The directory containing the JavaCC distribution.
void
setOnetable(boolean oneTable)
Sets the ONE_TABLE documentation option.
void
setOutputfile(String outputFile)
The outputfile to write the generated BNF documentation file to.
void
setTarget(File target)
The javacc grammar file to process.
void
setText(boolean plainText)
Sets the TEXT BNF documentation option.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

JJDoc

public JJDoc()
Constructor

Method Details

execute

public void execute()
            throws BuildException
Do the task.
Overrides:
execute in interface Task
Throws:
BuildException - if there is an error.

setJavacchome

public void setJavacchome(File javaccHome)
The directory containing the JavaCC distribution.
Parameters:
javaccHome - the home directory.

setOnetable

public void setOnetable(boolean oneTable)
Sets the ONE_TABLE documentation option.
Parameters:
oneTable - a boolean value.

setOutputfile

public void setOutputfile(String outputFile)
The outputfile to write the generated BNF documentation file to. If not set, the file is written with the same name as the JavaCC grammar file with a suffix .html or .txt.
Parameters:
outputFile - the name of the output file.

setTarget

public void setTarget(File target)
The javacc grammar file to process.
Parameters:
target - the grammar file.

setText

public void setText(boolean plainText)
Sets the TEXT BNF documentation option.
Parameters:
plainText - a boolean value.