来自@file和@defgroup的Doxygen复制文档

时间:2015-04-09 20:39:25

标签: 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输出包含两次所有文档;一旦进入"模块文档"部分和再次在"文件文档"部分。在我的最终PDF文件(从LaTeX生成)中,这相当于25页纯粹重复的内容。

理想的解决方法是让myFile.c的文件文档说"请参阅@ref my_group"或类似的东西。有没有办法在Doxygen中实现这个目标?

1 个答案:

答案 0 :(得分:0)

找到可接受的解决方案:

  1. 创建Doxygen布局XML文件并配置Doxygen以使用它(instructions
  2. 打开XML文件;找到<group>标记;注释掉<detaileddescription><memberdef>部分
  3. 这导致仅在“模块文档”中生成成员列表,其中包含指向LaTeX / PDF输出中“文档文档”部分中的完整成员文档的超链接。 HTML输出已经以这种方式运行,因此没有显着改变。