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

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

3 голосов
/ 16 июня 2011

Я сейчас документирую какой-нибудь рубиновый код.У нас есть два класса, у каждого из которых есть метод с именем «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 в этом документе.

Спасибо!

1 Ответ

2 голосов
/ 27 июня 2011

Вы, вероятно, хотите связать метод экземпляра, а не метод класса. Class::SubClass#host должно работать.

Следующий пример делает то, что вы описываете. 

class A
  # first method
  def a
  end
end

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