Vinculación con un método por el mismo nombre en una clase diferente (RDOC)

Question

Estoy documentando un código de rubí en este momento. Tenemos dos clases que tienen un método llamado "host".

En una de estas clases, el método necesita algunos comentarios especiales. En la otra clase me gustaría referirme a la primera clase, y que esa referencia sea un enlace a ella.

Normalmente en RDOC, escribir el nombre de un método es suficiente para generar un enlace. En este caso, incluso si escribo Class::SubClass.host El enlace aún insiste en señalar el método en la clase actual.

¿Algún maestro de RDOC saben cómo hacer esto?

Aquí hay un ejemplo en FakeTown::Api donde quiero vincular a RealTown::Api'S Método #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

El enlace producido por RDOC se vincula inútilmente a la #host Método en este documento.

¡Gracias!

Answer 1

Probablemente desee vincular al método de instancia, no al método de clase. Class::SubClass#host Deberia trabajar.

El siguiente ejemplo hace, lo que está describiendo.

class A
  # first method
  def a
  end
end

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