Debian Codegraph @

www/doc/JJDoc.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <!--
4
5 Copyright (c) 2006, Sun Microsystems, Inc.
6 All rights reserved.
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are met:
10
11 * Redistributions of source code must retain the above copyright notice,
12 this list of conditions and the following disclaimer.
13 * Redistributions in binary form must reproduce the above copyright
14 notice, this list of conditions and the following disclaimer in the
15 documentation and/or other materials provided with the distribution.
16 * Neither the name of the Sun Microsystems, Inc. nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 THE POSSIBILITY OF SUCH DAMAGE.
31
32 -->
33 <head>
34 <title>JavaCC: JJDoc Documentation</title>
35 <!-- Changed by: Michael Van De Vanter, 14-Jan-2003 -->
36 <!-- Changed by: Tim Pizey, 08-March-2007 -->
37 </head>
38 <body bgcolor="#FFFFFF" >
39
40 <h1>JavaCC [tm]: JJDoc Documentation</h1>
41 <p>
42 JJDoc takes a JavaCC [tm] parser specification and produces documentation
43 for the BNF grammar. It can operate in several modes, determined by
44 command line options.
45 </p>
46
47 <dl>
48 <dt><code>TEXT</code></dt>
49
50 <dd>(default false)
51
52 <p>
53 Setting <code>TEXT</code> to true causes JJDoc to generate
54 a plain text format description of the BNF. Some formatting
55 is done via tab characters, but the intention is to leave it
56 as plain as possible.
57 </p>
58
59 <p>
60 The default value of <code>TEXT</code> causes JJDoc to
61 generate a hyperlinked HTML document.
62 </p>
63 </dd>
64
65 <dt><code>BNF</code></dt>
66
67 <dd>(default false)
68 <p>
69 Setting <code>BNF</code> to true causes JJDoc to generate
70 a pure BNF document.
71 </p>
72 </dd>
73
74 <dt><code>ONE_TABLE</code></dt>
75
76 <dd>(default true)
77
78 <p>
79 The default value of <code>ONE_TABLE</code> is used to
80 generate a single HTML table for the BNF. Setting it to
81 false will produce one table for every production in the
82 grammar.
83 </p>
84 </dd>
85
86 <dt><code>OUTPUT_FILE</code></dt>
87
88 <dd>
89 <p>
90 The default behavior is to put the JJDoc output into a file
91 with either .html or .txt added as a suffix to the input
92 file's base name. You can supply a different file name with
93 this option.
94 </p>
95 </dd>
96
97 <dt><code>CSS</code></dt>
98
99 <dd>
100 <p>
101 This option allows you to specify a CSS file name. If you supply
102 a file name in this option it will appear in a <code>LINK</code> element
103 in the <code>HEAD</code> section of the file. This option only applies
104 to HTML output.
105 </p>
106 </dd>
107 </dl>
108
109 <p>
110 Comments in the JavaCC source that immediately precede a
111 production are passed through to the generated documentation.
112 </p>
113
114 <p>
115 The results for JavaCC are given as <a href="JavaCC.txt">text</a> or <a href="JavaCC.html">HTML</a>.
116 </p>
117
118 <hr />
119
120 </body>
121 </html>