Ссылка на метод с тем же именем в другом классе (Rdoc)

Question

Я документирую какой-то рубиновый код прямо сейчас. У нас есть два класса, у обоих есть метод с именем "host".

В одном из этих классов метод нуждается в специальных комментариях. В другом классе я хотел бы сослаться на первый класс, и эта ссылка должна быть ссылкой на него.

Обычно в 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