在C++头文件中的原型上复制的功能文档 -> Doxygen

Function documentation duplicated on prototypes in C++ header files -> Doxygen

本文关键字：文档 gt Doxygen 功能 C++ 文件 原型 复制      更新时间：2023-10-16

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中文档，第二个在主.h文档中。对于大型项目，这几乎使文档的大小增加了一倍，重复、冗余功能文档。这是错误还是配置问题？

如果将EXTRACT_ALL设置为NO，并且只使用（/** @file */）记录头文件，那么doxygen将只显示头文件，并且仍然包括在函数定义中找到的文档。

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

您应该复制函数原型，而不是实现。但也许只需将HIDE_UNDOC_MEMBERS设置为YES就可以解决您的问题。

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

相关文章：