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

Question

我正在使用 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 中实现这一点？

Answer 1

找到可接受的解决方案：

1. 创建一个 Doxygen 布局 XML 文件并配置 Doxygen 以使用它 (instructions)
2. 打开 XML 文件；找到<group> 标签；注释掉 <detaileddescription> 和 <memberdef> 部分

这导致“模块文档”中仅生成了成员列表，其中包含指向 LaTeX/PDF 输出中“文件文档”部分中完整成员文档的超链接。 HTML 输出已经以这种方式运行，因此没有显着改变。