停止Rdoc在字符串上创建链接

时间:2013-04-24 15:56:41

标签: ruby rdoc

我第一次使用RDoc,而且我遇到了一个有点麻烦的问题。我的班级文档中有一行如下:

# * callingState

我在同一个名为State的项目中也有一个类。当我使用RDoc为我的项目生成文档时,它将上面一行的“State”部分链接到我的State对象。

我宁愿不这样做。有没有办法阻止此链接被RDoc自动创建?快速谷歌搜索没有产生任何结果,但我可能只是使用错误的术语进行搜索。

2 个答案:

答案 0 :(得分:0)

我没有看到这种具体情况发生。我试图重现它,但只有一个单词的一部分与一个类匹配时才创建链接。但是,我确实有很多事情,我不想链接到类或模块名称。在大写单词前加一个反斜杠对我来说是个窍门。

请参阅: How do I prevent RDoc from parsing a URL?

答案 1 :(得分:0)

RDoc 文档中有一个关于 Escaping Text Markup 的部分,这对我有帮助。

* This will not be linked to \RDoc::RDoc#document