在文件描述和主页中使用注释

时间:2014-03-13 14:15:21

标签: c++ doxygen

当我输入给定的doxygen注释命令 \ file 时,它会显示在文件描述中。

温我把命令 \ mainpage ,它出现在index.html页面中

如果我同时使用,doxygen只考虑最后使用的那个。如何在文件描述和主页中同时添加相同的注释?

提前致谢。

2 个答案:

答案 0 :(得分:3)

由于doxygen的工作方式,无法在 文件描述和主页面中使用相同的注释行。正如海报所说,如果它直接在\file之下,它会在文件描述中;如果它在\mainpage下,则进入主页面。

如果您希望相同的文字出现在多个地方,则必须将其复制,这可以使用例如\copydoc command/** \mainpage \copydoc myfile.cpp */会将\file评论从myfile.cpp复制到主页。

答案 1 :(得分:0)

查看mainpage命令的示例。