Question

我似乎无法找到可以抑制这些特定错误的位置或者为什么他们甚至首先注册。

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作为我们的文档格式。

Answer 1

@param要求说明遵循参数名称，上面缺少参数名称所以可能的修复可能是：

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

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

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

压制clang-tidy -Wdocumentation＆＃34;空段＆＃34;错误

1 个答案: