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

Question

Я документирую код ruby ​​прямо сейчас. У нас есть два класса, у которых есть метод, называемый «host».

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

Обычно в rdoc для ввода ссылки достаточно ввести имя метода. В этом случае, даже если я пишу Class::SubClass.host, ссылка по-прежнему настаивает на указании на метод в текущем классе.

Любые мастера rdoc там знают, как это сделать?

Вот пример в FakeTown::Api, где я хочу связать с методом RealTown::Api «s #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