【发布时间】:2012-02-24 07:14:36
【问题描述】:
我已将此添加到班级评论中:
@link http://www.google.com Google @endlink
但是,当我使用 doxygen 生成文档时,链接文本确实是“Google”,但链接是:
file:///media/portable/Examples/Doxygen/link/html/classClass1.html
谁能解释发生了什么问题?
【问题讨论】:
标签: doxygen
我已将此添加到班级评论中:
@link http://www.google.com Google @endlink
但是,当我使用 doxygen 生成文档时,链接文本确实是“Google”,但链接是:
file:///media/portable/Examples/Doxygen/link/html/classClass1.html
谁能解释发生了什么问题?
【问题讨论】:
标签: doxygen
我认为您错误地使用了\link。从 doxygen documentation 开始,\link 用于引用文件、类或成员等对象,并将对其中一个的引用作为其第一个参数。例如,如果我想在myClass 类中引用一个类方法func,我会使用
\link myClass::func link text ... \endlink
所有剩余的参数都被认为是链接的文本。我认为您的问题是您没有将有效对象作为第一个参数传递。我猜classClass1 是文件中您尝试包含链接的下一个对象,这就是\link 命令所指的内容。
链接到网址
Doxygen 会自动生成 URL 链接,因此不需要用 \link 和 \endlink 或任何其他命令包围链接。所以删除这些,看看是否能解决问题。
要手动指定链接文本,请使用 HTML 'a' 标签:
<a href="linkURL">link text</a>
有关 doxygen 如何处理自动链接 see this 文档页面的更多信息。
【讨论】: