rdoc、darkfish、およびthe：call-seq：タグ

Question

私はRDOCを使用してRubyプロジェクトを文書化する過程にあり、Darkfish RDOCフォーマッタを発見しました。私はそれが本当に好きですが、 :call-seq: タグは機能しなくなりました。代わりに、文字通りの文字列を置きます :call-seq: ドキュメントでは、コードブロックとしてコールシーケンス自体をフォーマットします。私のドキュメントの多くがインスタンス名とパラメーター名をで参照する必要があるため、私は次のすべてを取り出したくありません：私のコードからブロックします。 :call-seq: ブロック。他の誰かがこの問題を抱えていましたか？私は何をすべきか、そして回避策はありますか？確かに確信しています :call-seq: タグは以前にデフォルトのフォーマッタを使用していたときに機能していましたが、元の形式の生成に戻る方法を理解できないので確信が持てませんでした（ファイル以外の引数がないRDOCを呼び出して、たとえダークフィッシュ出力を生成します。ドキュメントフォルダーを削除します！）これを修正する方法を知っている人はいますか？

Answer 1

RDOCから移動することを強くお勧めします ヤード. 。それは古いコールシック自体をサポートしていませんが、代わりにタグ、特に @Overload タグは、Call-seqを優れて置き換えます。すべてのドキュメント rubydoc.info ヤードを使用して生成されます。

ヤードドキュメントからの@Overloadの例は次のとおりです。

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end