Doxygen @link到URL不能正确生成链接

时间:2012-02-01 15:41:29

标签: doxygen

我已将此添加到课堂评论中:

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

但是,当我使用doxygen生成文档时,链接文本确实是“Google”,但链接是:

  

文件:///media/portable/Examples/Doxygen/link/html/classClass1.html

任何人都可以解释出现了什么问题吗?

1 个答案:

答案 0 :(得分:32)

我认为你错误地使用了\link。从doxygen documentation开始,\link用于引用文件,类或成员之类的对象,并将其中一个引用作为其第一个参数。例如,如果我想在类func中引用类方法myClass,我会使用

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

将所有剩余的参数视为链接的文本。我认为你的问题是你没有传递一个有效的对象作为第一个参数。我猜想classClass1是您尝试包含链接的文件中的下一个对象,这就是\link命令所引用的内容。

链接到网址

Doxygen将自动生成URL链接,因此无需使用\link\endlink或任何其他命令包围链接。所以删除它们,看看是否能解决问题。

要手动指定链接文字,请使用HTML“a”标记:

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

有关doxygen如何处理自动链接see this文档页面的详细信息。