next up previous contents index
: Risa/Asir に C で書いたプログラムを加えるには? : Asir 用のライブラリの書き方 : HTML ファイルの生成   目次   索引

マニュアルの書き方 その 2 : コメントから自動生成する

前節で述べた方法とは別に, プログラム中に埋め込まれた構造化 されたコメントをもとに, texinfo ファイルを自動生成する方法も ある.

これは Asir Contrib プロジェクト (OpenXM の一部) で開発している ツール gentexi.c を用いる方法である. このツールは Risa/Asir のプログラムに埋め込まれたコメントから, texinfo のマニュアルのソースを生成する. gentexi.c は OpenXM 配布ファイル群のディレクトリ OpenXM/src/asir-contrib/packages/doc にある.

次の例は asir contrib の関数 base_replace の マニュアルの記述例である.

/*&usage begin: base_replace(S,Rule)
 It rewrites {S} by using the rule {Rule}
 example: base_replace(x^2+y^2,[[x,a+1],[y,b]]);
 example_description: x is replaced by a+1 and y is replaced by b in
 x^2+y^2.
end: */

gentexi でとりだしたい部分は /*&usage で始める. : で終る単語が gentexi 用のキーワードである. 始めの begin: と 最後の end: は必須のキーワードである. 変数は { } で囲む. 上の例以外のキーワードとしては, ref:description: がある.



Nobuki Takayama 平成15年9月12日