如何强制rdoc将关注的class_method作为类方法进行记录?

时间:2017-07-24 13:48:09

标签: ruby-on-rails rdoc

我正在为ActiveRecord编写一个提供关注点的宝石。其中一个安装了一个单例方法(也就是类方法),我想用rdoc来记录它。在阅读完rdoc文档后,我希望这可行:

module MyModule
  extend ActiveSupport::Concern

  class_methods do
    ##
    # :singleton-method:
    # This method does something useful.

    def my_class_method(*template_columns, **options)
      # ...
    end
  end
end

但rdoc似乎忽略了:singleton-method:并将其视为注释,my_class_method被错误地放置在" Instance Public Methods"部分。

我如何强制rdoc将此方法放在文档的类方法部分?

(Yard也是一个问题 - 它似乎完全忽略了class_methods部分)

0 个答案:

没有答案