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

Class JJDoc


public class JJDoc
extends Task

Runs the JJDoc compiler compiler.

Field Summary

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

JJDoc()
Sole constructor.

Method Summary

void
execute()
Called by the project to let the task do its work.
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

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

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

getProject, log, log, setProject

Constructor Details

JJDoc

public JJDoc()
Sole constructor.

Method Details

execute

public void execute()
            throws BuildException
Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.
Overrides:
execute in interface Task
Throws:
BuildException - if something goes wrong with the build

setJavacchome

public void setJavacchome(File javaccHome)
The directory containing the JavaCC distribution.

setOnetable

public void setOnetable(boolean oneTable)
Sets the ONE_TABLE documentation option.

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.

setTarget

public void setTarget(File target)
The javacc grammar file to process.

setText

public void setText(boolean plainText)
Sets the TEXT BNF documentation option.

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.