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

Question

我向 RubyGems 发布了 gem，它在 http://www.rubydoc.info/gems/step_sequencer/1.0.7 为我构建了文档。我注意到它不包括私有方法，这在我看来并不理想。我尝试将它们全部切换为受保护，但它们仍然没有出现。我改成public才出现

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

对于实例方法，我使用的是常规 private 关键字。对于 class 方法，我使用的是单例 class，例如：

class Foo
  class << self
    private
    def self.private_class_method
  end
end

即使我用 --private

添加 .yardopts 文件也没有出现

Answer 1

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

要包含特定的私有方法，请将 #:doc: 添加到方法定义中，如下所示：
```
def my_method #:doc:
```
要包含所有 private/protected 方法，请在从命令行生成文档时在末尾添加 --all 选项。如果您有更新文档的 rake 任务，您可以将此行添加到块中：
```
rdoc.options << "--all"
```

How to include private methods in rubydoc.info documentation