如何在YARD文档中创建任意链接?

时间:2009-08-18 13:51:41

标签: ruby documentation rdoc yard

我正在尝试在YARD文档中创建一些链接。我可以获得HTTP链接:

# I like {http://stackoverflow.com Stackoverflow}

呈现为

<p>I like <a href="http://stackoverflow.com">Stackoverflow</a></p>

但是电子邮件链接:

# You can email the {mailto:bugs@myproject.com bugs} list

给了我一个警告:

[warn]: In file `':: Cannot resolve link to mailto:bugs@myprojectmailto:bugs@myproject.com from text:

并呈现为

<p>You can email the <tt>bugs</tt> list</p>

我为链接尝试了常规的RDoc语法:

bugs[mailto:bugs@myproject.com]

但YARD似乎忽略了这一点。有谁知道更可靠的语法?

2 个答案:

答案 0 :(得分:3)

深入研究YARD的代码会显示问题:in gems/yard-0.2.3.5/lib/yard有第(73)行:

if name.include?("://")

不允许mailto链接。您可以用

替换此行
if name.include?("://") or name.include?("mailto:")

它会按你的意愿工作......不完全理想,但这就是我现在所拥有的。

答案 1 :(得分:3)

0.2.3.6将获得此支持