Clang 不知道 Doxygens retval 标签

Question

我正在尝试使用 clang 3.6 和 -Weverything 编译一个 C 文件，但它在我的 Doxygen 注释中失败，其中包含 \retval 标记。

我的代码是这样的:

/***************************************************************************/
/** 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。