YARD: Как создать документацию по плагину для вендоров? - PullRequest
0 голосов
/ 20 февраля 2012

Я использую Ruby on Rails 3.1.0 и гем YARD 0.7.4 для документации.Я реализовал работающий плагин (в каталоге ROOT_APP/vendor/plugins/<plugin_name>) и Я хотел бы документировать этот плагин .

Примечание : Когда я запускаю терминал yard docКоманда из корневого каталога моего приложения для генерации файлов документации, гем YARD не генерирует документацию, связанную с моим плагином (все остальные файлы документации генерируются правильно).

Итак, - этоли документировать плагины?Если да, то как я могу это сделать?

1 Ответ

1 голос
/ 20 февраля 2012

Я бы превратил это в драгоценный камень, с которым вы можете использовать ярд.Плагины поставщиков будут устаревшими в 3.2:

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

...