あおきです。

  In mail "[ruby-list:18770] Re: RD with Method Index (Re: I want rd2info (or rd2texi).)"
    matz / netlab.co.jp (Yukihiro Matsumoto) wrote:

> まつもと ゆきひろです

> |とりあえず、リファレンス的なものはたくさん書かれるだろう、というのは
> |ほぼわかってるので、ここらへんの部分はなんとかしたいところです。
> |
> |それで、ぱっと思い付く限りではやりかたは2通り。
> |
> | (1) リファレンスみたいなものは、きっとRubyのリファレンスマニュアルと
> |     だいたい同じ形式で書かれるだろうと仮定します。つまり、あるクラス
> |     についてのリファレンスの文章構造が、
(略)
> |     こんな感じになるであろうと仮定して、この形式に沿った文章構造の
> |     ドキュメントならば、メソッド索引などの付加情報も抽出できるという
> |     方法。
> | (2) メソッド宣言用の専用Headlineの文法を新しく定義する。
> 
> 1番目のやりかたに賛成です。ついでに引数かなにかで指定するオ
> プションにした方が良いと思います。一定の形式にしたがったRDファ
> イルにタグ(ラベル)をつけるpre-processorとかでも良いかも。

一番目の方法を使うことにして、前ちょっとだけ書いた RD-Header を
使うのはどうでしょう?

=begin RD-Header
Document-Type: stdreference
=end

なーんて書くと、Rubyリファレンス形式で書かれているとして扱って
くれるわけです(実際にどう扱うかはまた別の話ですけど)。
-------------------------------------------------------------------
あおきみねろう