Package org.codehaus.mojo.javacc
Class JJDoc
java.lang.Object
org.codehaus.mojo.javacc.ToolFacade
org.codehaus.mojo.javacc.JJDoc
Provides a facade for the mojos to invoke JJDoc.
- Version:
- $Id: JJDoc.java 10603 2009-09-06 15:05:08Z bentmann $
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
Consume and log command line output from the JJDoc process. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected int
execute()
Runs the tool using the previously set parameters.private String[]
Assembles the command line arguments for the invocation of JJDoc according to the configuration.void
Sets the option BNF.void
setCssHref
(String value) Sets the option CSS, i.e the hypertext reference to a CSS file for the generated HTML output.void
setGrammarEncoding
(String value) Sets the option GRAMMAR_ENCODING.void
setInputFile
(File value) Sets the absolute path to the grammar file to pass into JJDoc for documentation.void
setOneTable
(Boolean value) Sets the option value ONE_TABLE.void
setOutputFile
(File value) Sets the absolute path to the output file.void
Sets the option TEXT.toString()
Gets a string representation of the command line arguments.Methods inherited from class org.codehaus.mojo.javacc.ToolFacade
getLog, getToolName, run, setLog
-
Field Details
-
inputFile
The input grammar. -
outputFile
The option OUTPUT_FILE. -
grammarEncoding
The option GRAMMAR_ENCODING. -
cssHref
The option CSS. -
text
The option TEXT. -
bnf
The option BNF. -
oneTable
The option ONE_TABLE.
-
-
Constructor Details
-
JJDoc
JJDoc()
-
-
Method Details
-
setInputFile
Sets the absolute path to the grammar file to pass into JJDoc for documentation.- Parameters:
value
- The absolute path to the grammar file to pass into JJDoc for documentation.
-
setOutputFile
Sets the absolute path to the output file.- Parameters:
value
- The absolute path to the HTML/text file to generate.
-
setGrammarEncoding
Sets the option GRAMMAR_ENCODING.- Parameters:
value
- The option value, may benull
to use the value provided in the grammar or the default.
-
setCssHref
Sets the option CSS, i.e the hypertext reference to a CSS file for the generated HTML output.- Parameters:
value
- The option value, may benull
to use the default style.
-
setText
Sets the option TEXT.- Parameters:
value
- The option value, may benull
to use the default value.
-
setBnf
Sets the option BNF.- Parameters:
value
- The option value, may benull
to use the default value.
-
setOneTable
Sets the option value ONE_TABLE.- Parameters:
value
- The option value, may benull
to use the default value.
-
execute
Runs the tool using the previously set parameters.- Specified by:
execute
in classToolFacade
- Returns:
- The exit code of the tool, non-zero means failure.
- Throws:
Exception
- If the tool could not be invoked.
-
generateArguments
Assembles the command line arguments for the invocation of JJDoc according to the configuration.- Returns:
- A string array that represents the arguments to use for JJDoc.
-
toString
Gets a string representation of the command line arguments.
-