ruby-reference-manual:676
From: sheepman <sheepman@s...>
Date: Tue, 1 Jan 2008 22:29:03 +0900
Subject: [ruby-reference-manual:676] @param などと定義リスト
こんばんは sheepman です。 2点あります。 ひとつめは定義リストのパースの仕方を少し変えます。空行(改行だけの行)が パラグラフの区切りになります。 : t1 c1 c2 text というようなソースが <dl> <dt>t1</dt> <dd> <p> c1 </p> <p> c2 </p> </dd> </dl> <p> text </p> という風に変換されます。空行でパラグラフが分かれているのがわかると思います。 もう1点は割と大きな変更です。@param などに定義リストを使うようにします。 --- method dsc @param hoge dsc @return dsc @raise hoge dsc @see hoge が以下のように変換されます。 <dt><code>method</code></dt> <dd> <p> dsc </p> <dl> <dt>[PARAM] hoge:</dt> <dd> dsc </dd> <dt>[RETURN]</dt> <dd> dsc </dd> <dt>[EXCEPTION] hoge:</dt> <dd> dsc </dd> </dl> <p> [SEE_ALSO] hoge </p> </dd> @param などに定義リストを使うのは妥当だと思います。細かいデザインは スタイルシートで変更すべきものですし。とりあえずコミットしてみます。 -- sheepman / TAMURA Takashi sheepman@s... -- ML: ruby-reference-manual@m... 使い方: http://QuickML.com/