YARD:如何生成供应商插件文档?

时间:2012-02-20 13:30:07

标签: ruby-on-rails ruby ruby-on-rails-3 documentation yard

我正在使用Ruby on Rails 3.1.0和YARD 0.7.4 gem来进行文档编制。我实现了一个工作插件(在ROOT_APP/vendor/plugins/<plugin_name>目录中)和我想记录该插件

注意:当我从应用程序的根目录运行yard doc Terminal命令以生成文档文件时,YARD gem不会生成与我的插件相关的文档(正确生成所有其他文档文件)。

那么,是否可以记录插件?如果是这样,我该如何做到?

1 个答案:

答案 0 :(得分:1)

我会把它转换为宝石,你可以使用它。供应商插件将在3.2中弃用:

http://weblog.rubyonrails.org/2012/1/4/rails-3-2-0-rc2-has-been-released