YARDで出力できない関数があるので改善したい

Question

###発生している問題・エラーメッセージ
下記のコードで 関数dotがyardでドキュメント化されないので困っています。
関数strはきちんとドキュメント化されています。

コマンド

yardoc sample.rb

###該当のソースコード
file: sample.rb

# String extensions
module StringExtension
  
  refine String do
    
    # Combine strings by dot(.).
    # @example
    # "sample".dot("is_test") => "sample.is_test"
    def dot(str)
      self + "." + str
    end

  end
  
  # This is test func
  # @return [string] just "test"
  def str()
    p "test"
  end
  
end

###補足情報(言語/FW/ツール等のバージョンなど)
ruby 2.4.0p0 (2016-12-24 revision 57164) [x86_64-darwin15]
yard 0.9.12

Answer 1

こんにちは。

2014年のissue ですが yard のレポジトリで以下を見つけました。

YARD does not generate documentation for refinements #780

上記で作者さんは

YARD does not (yet) support refinements.

と言っています。

とりあえずの策として、このissueを投稿した方が、

I've found (I think) a partial workaround:

と言っている、
https://github.com/lsegal/yard/issues/780#issuecomment-45232202

にならって、

# String extensions
module StringExtension

    # @!method dot(str)
    # Combine strings by dot(.).
    # @example
    # "sample".dot("is_test") => "sample.is_test"

  refine String do

    def dot(str)
      self + "." + str
    end

  end

  # This is test func
  # @return [string] just "test"
  def str()
    p "test"
  end

end

としてやると、一応出るには出ましたが、
以下のような、ちょっと不満の残る感じ
になりました。

上記の issue 以外で、refinements について議論している
issue は無いようでした。

以上参考になれば幸いです。