YARD: документирование методов класса, добавленных включенным модулем

Я пишу документацию для своего драгоценного камня рубина, используя YARD . В моем драгоценном камне у меня есть код, который следует этому общему шаблону рубина, в котором модуль включается в класс, и этот модуль не только добавляет методы экземпляра, но также добавляет методы класса:

module Moo
  def self.included(klass)
    klass.extend ClassMethods
  end

  module ClassMethods
    def hello
      puts "hello"
    end
  end
end

class Foo
  include Moo
end

Foo.hello  # => class method runs, printing "hello"

По умолчанию YARD генерирует документацию для Класс Foo, который выглядит следующим образом:

Inadequate documentation of the Foo class

Я считаю, что эта документация неадекватна , потому что она не сообщает пользователю, что доступен метод Foo.hello . Чтобы узнать о hello , пользователь должен щелкнуть Moo , а затем щелкнуть ClassMethods .

Было бы здорово иметь список всех методов класса и экземпляра Foo на одной странице. Как я могу это сделать? Мне нужно изменить код или я могу добавить тег, чтобы дать YARD подсказку о ClassMethods ?

10
задан David Grayson 11 March 2015 в 20:09
поделиться