2011-06-15 13 views
3

私は現在、いくつかのルビコードを文書化しています。どちらも「ホスト」というメソッドを持つ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の例です。

ありがとうございます!

答えて

2

おそらく、クラスメソッドではなくインスタンスメソッドにリンクしたいと思うかもしれません。 Class::SubClass#hostが動作するはずです。

次の例は、あなたが何を記述しているかを示しています。

class A 
    # first method 
    def a 
    end 
end 

class B 
    # second method linking to A#a 
    def a 
    end 
end 
+0

Hmm nope ...「#Class :: SubClass#host」というコメントを挿入しても、リンクは現在のクラスのホストメソッドを指しています。しかし、ありがとう! – Ziggy

+0

これがなぜ機能しないのか分かりません。短縮された例を提供できますか?それはうまくいきませんか?たぶんそれはエラーを見つけるのに役立ちます。 –