私は現在、いくつかのルビコードを文書化しています。どちらも「ホスト」というメソッドを持つ2つのクラスがあります。別のクラス(Rdoc)で同じ名前のメソッドにリンクする
これらのクラスの1つでは、メソッドには特別なコメントが必要です。他のクラスでは、ファーストクラスを参照して、その参照をそのクラスへのリンクにしたいと思います。
通常、rdocでは、メソッド名を入力するだけでリンクを生成できます。この場合、たとえ私がClass::SubClass.host
を書き出すとしても、リンクは現在のクラスのメソッドを指し示すよう依頼します。
どのrdocマスターがこれを行う方法を知っていますか? RDOCによって生成リンクはunhelpfully右に戻るこの文書の#host
方法へのリンク
# Returns the host as defined in config.yml under the heading "url".
#
# It appears as though this method is no longer in use, as
# features/support/vcr_config.rb contains its own method
# by the same name which directly references RealTown::Api#url
def host
uri = URI.parse url
uri.host
end
:ここ
は私がRealTown::Api
の方法#host
にリンクしたいFakeTown::Api
の例です。
ありがとうございます!
Hmm nope ...「#Class :: SubClass#host」というコメントを挿入しても、リンクは現在のクラスのホストメソッドを指しています。しかし、ありがとう! – Ziggy
これがなぜ機能しないのか分かりません。短縮された例を提供できますか?それはうまくいきませんか?たぶんそれはエラーを見つけるのに役立ちます。 –