yard，如何在文档中包含图像？

Question

我想在庭院生成的文档中包含图像，但找不到如何做到这一点的地方……有人知道怎么做吗？

Answer 1

你可以在你的文档中添加<img />标签：

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

 end

Answer 2

使用rdoc-image:链接：

# Gets foo.
#
# rdoc-image:img/1.png
def foo(bar)
  "foo"
end

由码数呈现为

<p>Gets foo.</p>
<p><img src="img/1.png"></p>

rdoc-images:还可以在独立的*.rdoc文件中使用。

Answer 3

根据您的标记格式，您可能必须使用另一种机制。例如，如果使用Markdown，则语法为![Alt text](/path/to/img.jpg)。在RDoc中，img标签应该可以工作，但您可以检查他们是否为此添加了特殊的标记语法。请注意，RDoc可能(不确定)不喜欢XHTML，您应该使用不带结尾的/。