YARD: dokumentowanie metod klas dodanych przez dołączony moduł

Question

Piszę dokumentację dla mojego klejnotu ruby ​​przy użyciu YARD. W moim gem, mam kod, który Wynika to wspólny wzór rubinowy, gdy moduł jest zawarte w klasie, a moduł nie tylko dodaje metody instancji, ale również dodaje metody Klasa:

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" 

Domyślnie stocznia generowanie dokumentacji dla klasy Foo, który wygląda tak:

Myślę, że ta dokumentacja jest niewystarczającaponieważ nie poinformować użytkownika, że ​​metoda Foo.hello jest dostępna. Aby uzyskać informacje na temat hello, użytkownik musi kliknąć Moo, a następnie kliknąć ClassMethods.

Byłoby wspaniale mieć listę wszystkich metod klasy i instancji Foo na jednej stronie. Jak mogę to zrobić? Czy muszę zmienić kod, czy istnieje tag, który mogę dodać, aby dać YARD wskazówkę na temat ClassMethods?

Answer 1

Od v0.8.0 można użyć dyrektywy @!parse:

class Foo 
    include Moo 
    # @!parse extend Moo::ClassMethods 
end