Doxygen @link 到一个 URL 时无法正确生成链接

24

我将这个添加到了一个类的注释中:

@link http://www.google.com Google @endlink

然而,当我使用 Doxygen 生成文档时,链接文本确实是“Google”,但链接却指向:

file:///media/portable/Examples/Doxygen/link/html/classClass1.html

有人能解释一下出了什么问题吗?

1个回答

42

我认为你在错误地使用\link。根据doxygen的文档\link用于引用像文件、类或成员这样的对象,并将其中一个作为第一个参数的引用。例如,如果我想引用类myClass中的类方法func,我将使用

\link myClass::func link text ... \endlink

假设您要链接的所有其他参数都被视为链接文本。我认为您的问题是您没有将有效的对象作为第一个参数传递。 我猜classClass1是文件中包含链接并且这就是\link命令引用的下一个对象。

链接到URL

Doxygen将自动生成URL链接,因此无需在链接周围使用\link\endlink或任何其他命令。因此请删除它们并查看是否解决了问题。

要手动指定链接文本,请使用HTML 'a'标签:

<a href="linkURL">link text</a> 

了解更多有关doxygen如何处理自动链接的信息,请参阅文档页面。


myClass是一个复杂的模板名称,而Doxygen自动链接断开时,是否有一种方法可以在记录MyClass时“捕获”符号以进行链接?例如,在myClass文档块中添加@alias MyClassAlias,然后能够编写\link MyClassAlias link text ... \endlink - WaterFox
1
@WaterFox 这听起来像是一个不同的问题。如果你还在寻找答案,我建议你把这个问题写成一个新问题。 - Chris
1
@WaterFox,这听起来像是一个不同的问题。如果你仍在寻找答案,我建议你将其写成一个新问题。 - Chris

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接