liaison à une méthode du même nom dans une classe différente (Rdoc)

Question

Je documente actuellement du code Ruby.Nous avons deux classes qui ont toutes deux une méthode appelée "hôte".

Dans l'une de ces classes, la méthode a besoin de quelques commentaires spéciaux.Dans l'autre classe, j'aimerais faire référence à la première classe, et avoir cette référence comme un lien vers elle.

Normalement dans rdoc, taper le nom d'une méthode suffit à générer un lien.Dans ce cas, même si j'écris Class::SubClass.host, le lien insiste toujours pour pointer vers la méthode dans la classe courante.

Est-ce que les maîtres rdoc savent comment faire cela?

Voici un exemple dans FakeTown::Api où je veux créer un lien vers la méthode RealTown::Api de #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

Le lien produit par rdoc renvoie inutilement à la méthode #host de ce document.

Merci!

Answer 1

Vous souhaitez probablement créer un lien vers la méthode d'instance, pas vers la méthode de classe.Class::SubClass#host devrait fonctionner.

L'exemple suivant fait ce que vous décrivez.

class A
  # first method
  def a
  end
end

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