DOC_PARSE_TOOL¶

プログラムファイル群からkinkdoc文書をパースして、JSONデータを生成する、起動可能モジュール。

使い方

kink [Kink_options]... mod:kink/doc/DOC_PARSE_TOOL [Mod_options]... Module_base_paths...

コマンドは、Module_base_pathsから公開モジュールのプログラムファイルを探し、プログラムファイルからkinkdoc文書をパースする。そして、kinkdoc文書のJSONデータを出力する。

デフォルトでは、コマンドはJSONデータを標準出力に書き出す。 `--output` オプションが指定された場合、コマンドはJSONデータを指定されたファイルに出力する。

詳細な使い方と、ツールチェーンについては、マニュアルの「Kinkdoc: API文書化システム」の章を見よう。

Mod_options

• --title {Title} : kinkdoc文書のタイトルを指定する。

• --overview {Overview_file_path} : 概要テキストのkinkdocコメントの塊を含むプログラムファイルのパスを指定する。

• --output {Output_file_path} : JSONデータの出力先ファイルパスを指定する。

終了ステータス

コマンドが成功したら、終了ステータス0で終了する。

コマンドが失敗したら、0以外の終了ステータスで終了する。

6.44.1. DOC_PARSE_TOOL.main(Argv)¶

mainはモジュールの起動関数である。