c++ - 使用 Doxygen 注释不同文件中的函数

Question

我需要在几个 C++ 项目中注释一组函数。注释的目标是使用 Doxygen 创建 HTML 文档。一些项目文件(.h 和 .cpp)是由一种机器人自动编写的，生成过程无法更改。我希望能够评论在此类文件中声明和定义的函数。我想知道是否可以在不同的文件中注释一个函数，以便允许 Doxygen 构建 HTML 和图表文件。

这是一个例子:

File1.h(自动生成)

void foo(int a);

File1.cpp(自动生成)

#include "File1.h"
void foo(int a)
{
   /*Function body*/
}

main.cpp(手写的，想写啥就写啥)

#include "File1.h"

/**
Some proper comments for documenting function foo declared in File1.h and defined in File1.cpp
*/
int main(int a)
{
   /*Main body*/
}

感谢您的帮助、建议和提示。最好的事情。

Answer 1

过了一会儿我找到了问题的答案。可以在任何需要的地方对任何函数或成员函数添加注释。添加 @fn 命令来定义您正在注释的函数或成员就足够了。

完成我的问题中开始的示例，main.cpp 文件将如下所示:

#include "File1.h"

    /** @fn void myclass::foo(int a)
     *  @brief A member function.
     *  @param a: input parameter.
     */
int main(int a)
{
   /*Main body*/
}

如果你的函数不是类成员，就这样写:

/** @fn void foo(int a)
*  @brief A member function.
*  @param a: input parameter.
*/

谢谢idclev 463035818寻求您的评论和帮助。