Clang不知道Doxygens retval标签

Question

我正在尝试使用clang 3.6编译一个C文件,-Weverything但它在包含\retval标记的Doxygen评论中失败了.

我的代码看起来像这样:

/***************************************************************************/
/** Main Function.
 *
 * This function represents the main functionality.
 *
 * \retval 0 successful
 * \retval other failed
 */
int main(
    int argc,                               /**< argument count */
    char **argv                             /**< argument list */
)
{
    ...
    return 0;
}

当我尝试使用clang编译它时,我收到以下警告.

$> clang-3.6 -Wall -Weverything -Werror -o main main.c
main.c:31:4: error: unknown command tag name [-Werror,-Wdocumentation-unknown-command]
 * \retval 0 successful
   ^

我知道我可以通过提供禁用警告,-Wno-documentation-unknown-command但我认为这不是最佳解决方案.

Answer 1

正如评论所说，您可以使用以下选项：

-fcomment-block-commands=retval

这将阻止 clang 抱怨标签 \retval。