Class JJDoc
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.javacc.JJDoc
- All Implemented Interfaces:
java.lang.Cloneable
public class JJDoc extends Task
Runs the JJDoc compiler compiler.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description JJDoc()Constructor -
Method Summary
Modifier and Type Method Description voidexecute()Do the task.voidsetJavacchome(java.io.File javaccHome)The directory containing the JavaCC distribution.voidsetMaxmemory(java.lang.String max)Corresponds -Xmx.voidsetOnetable(boolean oneTable)Sets the ONE_TABLE documentation option.voidsetOutputfile(java.lang.String outputFile)The outputfile to write the generated BNF documentation file to.voidsetTarget(java.io.File target)The javacc grammar file to process.voidsetText(boolean plainText)Sets the TEXT BNF documentation option.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
JJDoc
public JJDoc()Constructor
-
-
Method Details
-
setText
public void setText(boolean plainText)Sets the TEXT BNF documentation option.- Parameters:
plainText- abooleanvalue.
-
setOnetable
public void setOnetable(boolean oneTable)Sets the ONE_TABLE documentation option.- Parameters:
oneTable- abooleanvalue.
-
setOutputfile
public void setOutputfile(java.lang.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(java.io.File target)The javacc grammar file to process.- Parameters:
target- the grammar file.
-
setJavacchome
public void setJavacchome(java.io.File javaccHome)The directory containing the JavaCC distribution.- Parameters:
javaccHome- the home directory.
-
setMaxmemory
public void setMaxmemory(java.lang.String max)Corresponds -Xmx.- Parameters:
max- max memory parameter.- Since:
- Ant 1.8.3
-
execute
Do the task.- Overrides:
executein classTask- Throws:
BuildException- if there is an error.
-