Doxygen 从@file 和@defgroup 复制文档

Question

我正在使用 Doxygen 来记录项目。在一个文件中，我有一堆 public 函数，我想将它们放在一个组中。我这样做如下：

/**
    @file myFile.c
    @brief This is a file. It has stuff.
*/
/**
    @defgroup my_group Group with myFile.c stuff
    @{
*/

//CODE & STUFF WITH DOCUMENTATION

/**
   @}
*/

问题是 LaTeX 输出两次包含此处的所有文档；一次在 "Module Documentation" 部分，一次在 "File Documentation" 部分。这相当于我最终的 PDF 文件（从 LaTeX 生成）中可能有 25 页完全重复的内容。

一个理想的解决办法是让 myFile.c 的文件文档说 "See @ref my_group" 或类似的东西。有没有办法在 Doxygen 中完成此操作？

Answer 1

找到可接受的解决方案：

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

这导致在 "Module Documentation," 中仅生成成员列表，并在 LaTeX/PDF 输出的 "File Documentation" 部分中提供指向完整成员文档的超链接。 HTML 输出已经以这种方式运行，因此没有显着改变。

Doxygen 从@file 和@defgroup 复制文档

Doxygen duplicate documentation from @file and @defgroup

doxygen

doxygen-addtogroup