別のクラス（RDOC）で同じ名前でメソッドにリンクする

Question

私は今いくつかのRubyコードを文書化しています。両方とも「ホスト」と呼ばれるメソッドを持っている2つのクラスがあります。

これらのクラスの1つでは、この方法にはいくつかの特別なコメントが必要です。他のクラスでは、ファーストクラスを参照し、その参照をリンクにしたいと思います。

通常、RDOCでは、メソッドの名前を入力するだけでリンクを生成するのに十分です。この場合、私が書き留めても Class::SubClass.host リンクは、現在のクラスのメソッドを指すことを依然として主張しています。

そこにいるRDOCマスターは、これを行う方法を知っていますか？

これが例です FakeTown::Api リンクしたい場所 RealTown::Api'の方法 #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

RDOCによって生成されたリンクは、無事にリンクします。 #host このドキュメントの方法。

ありがとう！

Answer 1

おそらく、クラスメソッドではなく、インスタンスメソッドにリンクする必要があります。 Class::SubClass#host 動作するはずです。

次の例は、あなたが説明していることです。

class A
  # first method
  def a
  end
end

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