Question

Doxygen在遇到函数原型时会重复函数文档头文件，例如：

代码：

#include <File main.h>

void Func1(void);


///File main.c:

#include <main.h>

/*! Main program entry point. */
main()
{
    Func1();
}

/*! Test function which does nothing. */
void Func1(void)
{
    return;
}

为Func1（）生成两个文档：main.c中的第一个文档，以及main.h文档中的第二个。有一个大项目，这几乎使文档的大小翻倍，重复，冗余功能文档。这是一个错误还是一些配置问题？

Answer 1

如果您将EXTRACT_ALL设置为NO并仅使用（/** @file */）记录头文件，则doxygen将仅显示标题，并且仍包含函数定义中的文档。< / p>

如果您同时记录标题和源文件或将EXTRACT_ALL设置为YES，那么doxygen会将该函数的文档显示为标题的一部分，并作为源文件文档的一部分。这是功能，而不是错误： - ）

Answer 2

您应该复制函数原型而不是实现。但是，将HIDE_UNDOC_MEMBERS设置为YES可能会解决您的问题。

Answer 3

配置doxygen按名称空间而不是按文件对自由函数进行分组。

函数文档在C ++头文件中的原型上重复 - ＆gt; Doxygen的

3 个答案: