Rails で実装されたサービスの YARD ドキュメントを生成しようとすると、次の警告が表示されます。
$ yardoc
[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin:
YARD::Parser::UndocumentableError for class MyClass
[warn]: in file 'app/models/my_class.rb':7:
7: include Rails.application.routes.url_helpers
私の理解では、YARD はミックスインのタイプを判断できないということです。ミックスインのタイプは実行時にのみ利用できるためです。
それで、ここで何をするのが正しいのでしょうか?ミックスインを正しく文書化することは可能ですか?そうでない場合、警告を取り除くにはどうすればよいですか?
Yard Undocumentable Error docs 説明があなたの質問に答えるかもしれません。私の知る限り、警告を取り除くには、yardoc を Quiet モードで実行するというオプションがあります。
yardoc -q /path/to/source/file