jenkins - Doxygen 需要一些额外的命令

Question

我正在使用 Jenkins 构建一个管道，其中还包括构建我的 C/C++ 库的 Doxygen 文档。

当方法的参数没有记录时，Doxygen 会自动发出警告。

/**
 * @brief The brief of foo
 *
 */
void foo(int i)
{
}

这将产生如下警告：

error: The following parameters of foo(int i) are not documented: parameter 'i'

我可以轻松地为每个文件需要的其他字段添加测试吗？如果不包含 Doxygen 是否会生成警告？

以以下为例：

每个文件都应包含相同的标题，如下所示：

/**
 * @file        foo.cpp
 * @brief       The brief
 * @copyright   Copyright [2020-2021] The Company
 * @authors     the author
 * @date        2021-09-27
 */

如果 Doxygen 运行并且缺少命令/字段之一，Doxygen 应该生成如下警告：

Required command @file is missing!

我可以像这样配置 Doxygen 吗？

标签： jenkinsdoxygen