ruby - yard，如何将图像包含到文档中？

Question

我想在 yard-genereted 文档中包含图像，但无法在任何地方找到如何执行此操作...有人知道如何执行此操作吗？

Answer 1

您可以只添加 <img />标记到您的文档:

 # Blah-blah 
 # 
 # <img src=img/1.png />
 # @param [String] blah
 # @return [String] blah
 def foo(bar) 

 end