抑制特定的Doxygen警告

Question

看起来其他人之前也问过这个问题。只是想确认一下是否已经找到答案。

我遇到了几种情况：当我记录各种功能时，有时会遇到这样的情况，我希望记录某些函数参数，但不是所有参数。例如：

/** 
 * This is the brief description for the function.
 * And here is the detailed description.
 * @param foo This parameter is not self-explanatory and needs a blurb
 */
void some_function(void *foo, int self_explanatory) {
    // function does stuff
}

在Doxygen文档中添加"self_explanatory"参数只会增加混乱，所以我宁愿不加。但是，Doxygen会警告说该参数未记录。我正在使用Eclox，这些我不关心的警告很烦人。

现在，我的doxyfile已经设置了以下选项：

EXTRACT_ALL          = YES
WARNINGS             = YES
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR    = YES
WARN_NO_PARAM_DOC    = NO

警告仍然会生成。

其中一个选项是在有问题的代码周围添加@cond和@endcond，但这样一来，我的函数的所有文档都没有生成。我需要文档，只是不需要警告。

我想要的东西类似于...

/** @nowarn
 * This is the brief description for the function.
 * And here is the detailed description.
 * @param foo This parameter is not self-explanatory and needs a blurb
 * @endnowarn
 */
void some_function(void *foo, int self_explanatory) {
    // function does stuff
}

...以使在封闭的代码块中不会生成警告。

我找到的其他SO问题：
抑制Doxygen警告
抑制未记录成员函数的Doxygen警告，但保留概要信息
是否可以选择要显示的Doxygen警告？

- Bryant

Answer 1

在这种情况下，我通常会写：

@param self_explonatory

（只声明参数而不添加任何说明）。通常这是明智的，因为参数会显示在参数表中。

（尽管如此，我真的很希望有一些选项来暂时禁用其他情况下的警告...）

- Mekk

Answer 2

只需记录自解释参数，或记住警告只是警告。Doxygen 告诉你的只是可能有些事情被忽略了。

你可以接受警告，也可以忽略它。如果你真的想要抑制那个警告，你可能需要查看你链接的第一个线程。具体来说，https://dev59.com/AHA75IYBdhLWcg3wB0ZP#25137529。

- Henry Malinowski

---

响应不佳。您没有提供任何原始问题中已经提供的信息。我想要抑制警告，因为我正在使用eclox，大量的警告是不可接受的。而且，我不希望记录自解释参数，以避免在源文件中产生噪音。 - Bryant