【问题标题】:disable auto link in Doxygen在 Doxygen 中禁用自动链接
【发布时间】:2018-04-08 08:47:43
【问题描述】:

如果我在源代码 cmets 中写一些 URL,例如:

/**
 * Here is an inline link [test](http://www.test.com).
 * More information:
 * <a href="http://www.test.com">test</a>
 */

我在 Doxygen 中启用了GENERATE_XML。这是它生成的:

<para>Here is an inline link [test](<ulink url="http://www.test.com">http://www.test.com</ulink>).
More information:
<ulink url="http://www.test.com">test</ulink> </para> 

转换标签后,我可以创建一个 Markdown 内容,如:

Here is an inline link [test](<a href="http://www.test.com">http://www.test.com</a>).
More information:
<a href="http://www.test.com">test</a>

请注意,Markdown 链接[test](&lt;a href="http://www.test.com"&gt;http://www.test.com&lt;/a&gt;) 已被污染,在我将其输入另一个 Markdown 处理器后,这将断开链接。我需要这个,因为我想在 cmets 中编写一些降价,并将其提取为一些结构化数据格式,以便其他工具处理降价。我在 Doxygen 中禁用了 MARKDOWN_SUPPORT

我尝试在 doxyfile 中禁用 AUTOLINK_SUPPORT,但它只能禁用到类/方法/的内部类型链接...

【问题讨论】:

  • 你能指定你正在使用的doxygen版本,标准Doxyfile(doxygen配置文件)之间的差异并包含一个显示问题的小代码sn-p。
  • 怎么样:[test](%http://www.test.com)
  • @albert 谢谢!有效。在我们的场景中,最好在工具中解决此问题以避免更改现有源代码。但如果有充分的理由这样做也是可以接受的。 Doxygen 有这方面的任何文件吗?

标签: doxygen


【解决方案1】:

上述问题的解决方案,自动链接网址,是使用[test](%http://www.test.com)。通过% 符号,(自动)链接被禁止。

在文档中,“第 3 步:记录源代码”段落:

为与文档类对应的单词创建链接(除非该单词前面有一个 %;那么该单词将不会被链接并且 % 符号被删除)。

注意:在上面的引用中,该措辞仅适用于类,但它也适用于其他地方。其他地方也出现同样的“问题”:

  • AUTOLINK_SUPPORT 的说明
  • FAQ Doxygen 在某处自动生成指向 MyClass 类的链接 在运行的文本中。如何在某个地方防止这种情况发生?
  • 类的段落链接
  • 段落“\%”

【讨论】:

    猜你喜欢
    • 2013-12-04
    • 1970-01-01
    • 2014-07-26
    • 1970-01-01
    • 2018-09-08
    • 2017-05-31
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多