如何在rubydoc.info文档中包含私有方法

Question

我向RubyGems发布了一个gem，它在http://www.rubydoc.info/gems/step_sequencer/1.0.7为我构建了文档。我注意到它没有包含从我的观点来看不理想的私有方法。我尝试将它们全部切换到受保护但它们仍然没有显示出来。只有当我把它们改为公开时​​才出现。

有没有办法配置RubyGems以使用我自己的配置发布文档？

例如，方法，我使用的是常规3px关键字。对于类方法，我使用的是单例类：

private

即使我使用class Foo class << self private def self.private_class_method end end

添加.yardopts文件，也不会显示

Answer 1

我遇到了同样的问题，并找到了关于如何在rdocs中包含私有和受保护方法的答案，尽管需要进行一些挖掘。有两种方法可以做到这一点。

1. 要包含特定的私有方法，请将#:doc:添加到方法定义中，如下所示：

   def my_method #:doc:
   

2. 要包含所有私有/受保护方法，请在命令行生成文档时在末尾添加--all选项。如果您有更新文档的rake任务，可以将此行添加到块中：

   rdoc.options << "--all"