我有两个C源文件。对函数的注释bar()
在文件中A
需要引用的函数foo()
文件B
。如何建立此连结?
我试过了:
编写类似的内容:B.c::foo()
希望doxygen可以归档B
并在其中找到功能foo
。
也尝试简单,::foo()
但没有帮助。
然后,我尝试给文件B.c
一个特殊的标记名,就像在//! @file specialtag
第一行中B.c
所做的specialtag::foo()
那样,然后在我的注释中这样做,但是并没有太大改变。
我试图用\ref
和强制链接,\link
但即使那样也没有帮助。
//! @file
两者中都存在该行A.c
,B.c
因此doxygen应该注意该代码。
编辑
我尝试了@doxygen的建议,但是没有运气。我制作了一个示例项目来显示我在哪里遇到问题,在这里:http : //www.filedropper.com/testdoxygen2tar
我使用的默认设置文件doxygen -g
。我得到的输出:
您会看到foobar函数未链接到。
编辑2
找到了问题。该函数foo
没有文档说明,因此没有生成任何页面,因此doxygen当然没有链接到的页面。(我正在生成SOURCE_BROWSER
启用了该选项的文档,并希望会生成指向函数定义的链接)
这很简单。这是一个使用默认配置文件(doxygen -g
)的最小示例:
首先创建具有以下内容的文件foo.c:
/** @file */
/** Function foo, see also bar(). */
void foo()
{
}
然后使用以下内容创建文件bar.c:
/** @file */
/** Function bar, see also foo(). */
void bar()
{
}
运行doxygen,并在HTML输出中观察到这两个函数都将链接到另一个函数。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句