如何用Doxygen文件包含文件

Question

我在源代码中有一些包含我要添加“待办事项”的内容。

例如：

/** \todo Review. */
#include "anyfile.h"

/** todo Another to do. */
#define ANY_MACRO 1

问题是第一个“待办事项”是插入宏定义而不是包含在内，如下所示：

-----------------------------------
**Todo List**

Global **ANY_MACRO**

Review.

Another to do.

-----------------------------------

知道如何解决这个问题吗？

Answer 1

关注online doc：

  

让我们重复一遍，因为它经常被忽视：要记录全局对象（函数，typedef，枚举，宏等），你必须记录定义它们的文件。

然后我按以下方式处理您的问题：我必须在两个文件中都有\file条评论，并且在包含行上方，我提到todo部分引用了包含的文件。

换句话说，我在我的源文件afile.c中写这个：

/** \file anyfile.h
 *  \todo Review
 */
#include "anyfile.h"

/** \file afile.c
 *  \brief Some code
 */

/** \todo wait, a todo !*/
#define A_MACRO

int main()
{}

在包含的文件中，我写了一篇关于文件本身的简短评论：

/** \file anyfile.h 
 *  Very interesting header
 */

#define B_MACRO

作为输出，todo注释放在包含文件的doc页面中。根据我的尴尬部分是我必须将块/** \file afile.c */放在包含行之后，否则它不起作用。