[ruby-gnome2-devel-ja] リファレンスについて

[Masaaki A. <mas...@gm...>]

青柳です。

以前お伝えしたように、リファレンスにYARDを使用することを提案します。

移行方針としては、
 * girからYARDドキュメントを自動でソースに埋め込む
　その際、todoタグ(fixme)を追加しておく
 * 英語圏の人を中心に、既存のHikiとソースの内容を踏まえて修正してもらう
　修正が完了したらtodoタグを削除する
というのを考えています。

まだまだ作業中ですが、ある程度ツールを書いたのでプレビュー版？として添付します。
yagi_gnomeというのが作成したツールで、使い方は、
　$ gem install yagi_gnome
　$ gem install vte
　$ yard config -a autoload_plugins gnome
　$ yard server -g
　ブラウザから、http://localhost:8808/ にアクセス
という感じを想定しています。（gemはアップされていないので、添付のものを入れてください）

ただ、上記の方法はgemインストール時にソースからリファレンスを生成するのですが、
以下のような問題があるので、生成済みのドキュメントも配布した方がいいのかなと考えています。
 * ツールがRuby1.9.2以降しかサポートしない
 * Windowsの場合、ソースからインストールしないので、リファレンスが生成されないはず
 * メソッドの数が多いと表示が遅い（うちの環境ではVte::Terminalの表示に１０秒程度もかかる）
生成したドキュメントのサンプルを、vte-doc.tar.bz2として添付します。
doc/frames.htmlを開けば見れるはずです。

いかがでしょうか？

それと、添付しちゃいましたが、どこかにファイル置き場みたいなとこがありましたでしょうか？