JJDoc

Apache Ant 1.6 以降

説明

JJDoc 構文解析器コンパイラのための JavaCC コンパイラコンパイラプリプロセッサを呼び出します。JavaCC パーサースペシフィケーションを取り、BNF 文法のためのドキュメントを作成します。コマンドラインオプションによって定義された 3 つのモードで動作します。

jjdoc タスクを使用するには、target 属性を処理する JavaCC 文法ファイルの名前に設定します。Ant が JavaCC クラスを見つけられるように、javacchome 属性を使って JavaCC のインストールが含まれているディレクトリを指定する必要があります。さらに、生成された BNF ドキュメントファイルを特定の (ディレクトリと) ファイルに書き込む outputfile を設定することもできます。または、jjdoc は生成された BNF ドキュメントファイルを、サフィックス .txt または .html が付与された JavaCC 文法ファイルとして書き込みます。

このタスクは、文法ファイルが生成された BNF ドキュメントファイルよりも新しい場合にのみ JJDoc を呼び出します。

パラメータ

属性 説明 必須
target 処理する JavaCC 文法ファイル はい
javacchome JavaCC distribution が含まれるディレクトリ はい
outputfile 生成された BNF ドキュメントファイルを書き込むファイル。設定されていない場合は、ファイルは JavaCC 文法ファイルと同じ名前で、サフィックスは .html または .txt になります いいえ
text TEXT BNF ドキュメントオプションを設定します。これは boolean オプションです いいえ
onetable ONE_TABLE BNF ドキュメントオプションを設定します。これは boolean オプションです いいえ
maxmemory フォークされた JVM に割り当てるメモリの最大容量。Ant 1.8.3 以降 いいえ

文法ファイル src/Parser.jj で JJDoc を呼び出し、生成された BNF ドキュメントファイル ParserBNF.htmldoc に書き込みます。

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