在页面中显示Doxygen的文档

时间:2018-03-14 16:04:46

标签: doxygen

在C项目中,我必须将代码记录在专用的.dox文件中,而不是C文件本身。

摘自.dox文件:

/*! \page intro2 Introduction2
Sample text

\fn void foo(void)
@brief foo

foo does nothing.
*/

文档将出现在foo.h文件下的“文件列表”中,其中定义了我的函数。我的页面只显示“示例文本”行。

在“示例文本”行之后,有没有办法在页面本身中获取文档?

我知道我可以通过团队实现这一目标。但是因为Doxygen没有以相同的方式管理组和页面,所以我更喜欢在\ page中获取文档。

谢谢,

1 个答案:

答案 0 :(得分:0)

/*! \page intro2 Introduction2
Sample text

foo

foo does nothing.
*/

.h For foo

\fn void foo(void)
@brief foo

不完全是你想要的,但我认为它现在都会进入一个页面,你可以通过链接点击阅读有关该功能的内容。如果您真的希望文档在页面中,您也可以尝试使用\copydoc