2012-02-01 103 views
19

我已经加入这个类评论:Doxygen的@link到URL不生成链接是否正确

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

然而,当我使用的doxygen生成文档,链接文本确实是“谷歌”,但这个链接是:

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

谁能解释什么错误?

回答

29

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

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

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

链接到网址

的Doxygen会自动生成URL链接,所以没有必要围绕与\link\endlink或任何其他命令的链接。所以删除这些,看看是否解决了这个问题。

要手动指定链接文本,使用HTML的一个标签:

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

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

+0

我明白了,谢谢克里斯! – 2012-02-01 16:51:11