ドキュメント

バグの方も落ち着いてきたので、APIを整理しながらドキュメントを書き始めることにしました。最初に手をつけたのは一番面倒そうなFFIとCの構造体の部分で、下記のURLにドラフトをアップロードしています。
http://www.littlewing.co.jp/ypsilon/doc-draft/
ドキュメントは最初はtexinfoで書こうと思いemacsのtexinfoモードで書き始めたのですが、すぐにちゃぶ台をひっくり返したい気分になりました。最初にemacsに触ってからもう20年近くたってると思うんですが・・・未だに相性が悪いようです :p
そうなるとtexinfoで書くのも面倒に思えたので、自分好みの書式で書くことのできる簡単なシステムを作りながら書くことにしました。入力はこんな感じになります。
(ypsilon ffi)のソース:
http://www.littlewing.co.jp/ypsilon/doc-draft/source.ypsilon.ffi.html
(ypsilon c-types)のソース:
http://www.littlewing.co.jp/ypsilon/doc-draft/source.ypsilon.c-types.html
ここからスタイル情報、リンク、目次などを自動生成しています。これだとシンタックスハイライトもインデントもScheme用の設定がそのまま使えてかなり幸せな気分になりました。
プログラムはドキュメントを書きながら必要な機能を継ぎ足して作っています。Schemeのプログラムと入力データを一つのファイルに入れておいて、それらを書き換えながらインタラクティブに動作を確認できるというのは素晴らしいですね。これもS式のおかげです。:D