在doxygen中使用@see或@link

时间:2012-08-16 16:26:43

标签: java javadoc doxygen

我之前使用Javadoc进行了记录,并在我的描述中使用了标记@see@link{@see foo}{link foo}来链接到其他类。现在我尝试了doxygen,似乎这些标签是不兼容的。如果我运行doxygen,则完整标签只会被解释为普通文本。

我可以用任何替代标签来获得相同的功能吗?

3 个答案:

答案 0 :(得分:4)

要链接到其他类,您应该使用ref命令。您可以使用\link命令,但必须使用\endlink命令结束链接文本,我怀疑这是您的问题(尽管没有我无法确定的示例文档)。

automatic linking上的doxygen手册部分,我建议您阅读,有一个关于课程链接的段落:

  

文档中与文档类对应且包含至少一个非小写字符的所有单词将自动替换为包含该类文档的页面的链接。如果您想防止与文档类相对应的单词被链接替换,您应该在单词前放置%。要链接到全小写符号,请使用\ref

还需要考虑一些要点:

  • Doxygen确实接受\see(与\sa}和\link命令的同义词。如果这些没有按预期工作,那么OP应该包含一些示例文档,我们可以尝试并解决这个问题无法按预期工作。

  • 带有{\command description}{的符号}在doxygen文档中并不常见,我不确定该程序将如何处理这些因此可能是最好不要使用这种风格。

答案 1 :(得分:1)

我怀疑您正在使用//

发表评论

Doxygen会以这种方式捕获标签:

/**
* @KEYWORD DESCRIPTION
*/ 

您还可以添加第三个/,使每个评论行以///开头,因为doxygen也会抓住这个。

答案 2 :(得分:0)

我偶然发现了一篇很好的文章,比较了javadoc和doxygen,显示了一些示例等效代码(@link等)。你可以看到它here。我希望它有所帮助。

相关问题