我似乎无法找到可以抑制这些特定错误的地方,或者为什么它们甚至首先要注册。
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 作为我们的文档格式。