JJDoc Task

From 753a6c60f47f3ac4f270005b65e9d6481de8eb68 Mon Sep 17 00:00:00 2001 From: Ashlee Young Date: Fri, 23 Oct 2015 10:00:02 -0700 Subject: Adding maven and ant source trees Change-Id: I0a39b9add833a31b9c3f98d193983ae2f3a5a445 Signed-off-by: Ashlee Young --- .../ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html | 123 +++++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html') diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html new file mode 100644 index 00000000..52b92257 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/jjdoc.html @@ -0,0 +1,123 @@ + + + + + + + +JJDoc Task + + + +

+JJDoc

Since Apache Ant 1.6

Description

+ +

Invokes the JJDoc preprocessor +for the JavaCC compiler compiler. It takes a JavaCC parser specification +and produces documentation for the BNF grammar. +It can operate in three modes, determined by command line options. +

To use the jjdoc task, set the target attribute to the name +of the JavaCC grammar file to process. You also need to specify the directory +containing the JavaCC installation using the javacchome attribute, +so that ant can find the JavaCC classes. Optionally, you can also set the +outputfile to write the generated BNF documentation file to a specific (directory and) file. +Otherwise jjdoc writes the generated BNF documentation file as the JavaCC +grammar file with a suffix .txt or .html.

This task only invokes JJDoc if the grammar file is newer than the +generated BNF documentation file.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute	Description	Required
target	The javacc grammar file to process.	Yes
javacchome	The directory containing the JavaCC distribution.	Yes
outputfile	The file to write the generated BNF documentation file to. If not set, +the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt.	No
text	Sets the TEXT BNF documentation option. This is a boolean +option.	No
onetable	Sets the ONE_TABLE BNF documentation option. This is a boolean option.	No
maxmemory	Max amount of memory to allocate to the forked + VM. since Ant 1.8.3	No

+ +

+Example

+ +

<jjdoc 
+    target="src/Parser.jj" 
+    outputfile="doc/ParserBNF.html"
+    javacchome="c:/program files/JavaCC" 
+/>

+This invokes JJDoc on grammar file src/Parser.jj, writing the generated +BNF documentation file, ParserBNF.html, file to doc. +
+ + + + -- cgit 1.2.3-korg