Doxygen从@file和@defgroup复制文档
我正在使用Doxygen来记录一个项目。在一个文件中,我有一堆公共函数,我想把它们放在一个组中。我的做法如下:Doxygen从@file和@defgroup复制文档,doxygen,doxygen-addtogroup,Doxygen,Doxygen Addtogroup,我正在使用Doxygen来记录一个项目。在一个文件中,我有一堆公共函数,我想把它们放在一个组中。我的做法如下: /** @file myFile.c @brief This is a file. It has stuff. */ /** @defgroup my_group Group with myFile.c stuff @{ */ //CODE & STUFF WITH DOCUMENTATION /** @} */ 问题是,LaTeX输
/**
@file myFile.c
@brief This is a file. It has stuff.
*/
/**
@defgroup my_group Group with myFile.c stuff
@{
*/
//CODE & STUFF WITH DOCUMENTATION
/**
@}
*/
问题是,LaTeX输出包含此处的所有文档两次;一次在“模块文档”部分,另一次在“文件文档”部分。在我的最终PDF文件(由LaTeX生成)中,这相当于25页纯粹重复的内容
一个理想的解决方案是让myFile.c的文件文档显示“See@ref my_group”或类似的内容。是否有一种方法可以在Doxygen中实现这一点?找到了可接受的解决方案:
标签;注释掉
和
部分