Doxygen：如何重新定义虚空

Question

我使用了一个重新定义void类型的库（以及其他）：

#define XX_VOID void

所以当我在像

这样的代码上运行doxygen时

/**
 * @brief Function description
 */
XX_VOID foo(XX_VOID)
{
    /*...*/
}

我收到了警告

file.c:10: warning: return type of member foo is not documented

如何告诉Doxygen XX_VOID无效，因此没有返回值？

Answer 1

您可以尝试使用MACRO_EXPANSION标记：

  

<强> MACRO_EXPANSION

     

如果MACRO_EXPANSION标记设置为YES，doxygen将扩展源代码中的所有宏名称。如果设置为NO，则仅执行条件编译。通过将EXPAND_ONLY_PREDEF设置为YES，可以以受控方式完成宏扩展。

     

默认值为：NO。

     

此标记要求标记ENABLE_PREPROCESSING设置为YES。

将MACRO_EXPANSION设置为YES后，doxygen预处理后的结果变为：

void foo(void)
{
  /* ... */
}