3

我似乎无法找到可以抑制这些特定错误的地方，或者为什么它们甚至首先要注册。

error: empty paragraph passed to '@param' command

这是我拥有的生成此错误的文档：

//----------------------------------------------------------
///
/// @brief functionThatModifiesSomething
///
/// @param[in] param1
/// @param[in] param2
///
//-----------------------------------------------------------
void functionThatModifiesSomething(uint32_t param1, uint32_t param2);

我只是注意到这一点，因为我终于打开了其中一些警告，并且我正在清理。

看到警告后，我不明白为什么当@param 不是空段落时它会注册错误。有什么想法吗？我可以以某种方式抑制这种文档警告的味道吗？

这是完整的错误：

./path/to/somefile.hpp:570:21: error: empty paragraph passed to '@param'     command [-Werror,-Wdocumentation]
/// @param param1
    ~~~~~~~~~~~~^

我们使用 Doxygen 作为我们的文档格式。

4

1 回答 1

3

@param期望在参数名称之后有一个描述，而上面缺少该描述。
因此，可能的解决方法可能是：

/// @param[in] param1 Description #1
/// @param[in] param2 Description #2

有关文档，请参阅http://www.doxygen.nl/manual/commands.html#cmdparam 。@param

Clang 的文档警告使用 启用-Wdocumentation，默认情况下禁用。有一大堆来自不同类型的文档警告，它们都由 启用-Wdocumentation，但不幸的是，您不能选择退出单个警告，例如“传递给@command 的空段落”警告。

于 2018-01-16T21:02:49.977 回答