使正确的 doxygen 文档成为构建要求

Question

我正在使用 Doxygen 记录一个越来越大的 C++ 项目，我一直想知道如何使 Doxygen 成为项目的构建要求。换句话说，如果有任何类/方法/等，我希望我的构建过程失败并停止。 Doxygen 尚未成功记录。我使用make 进行构建。

例如，我希望它失败（即不构建）：

/**
 * @bbrief Oops, tag does not exist, warning is issued and hence build fails.
 */
void f()
{
    // Do something...
}


/**
 * @brief Main function for program X
 *
 * @return End of execution status.
 *
 * ...
 *
 */
int main()
{
    f();

    return 0;
}

但是这个要构建：

/**
 * @brief Okay, this is fine.
 *
 */
void f()
{
    // Do something...
}


/**
 * @brief Main function for program X
 *
 * @return End of execution status.
 *
 * ...
 *
 */
int main()
{
    f();

    return 0;
}

我曾尝试在 Internet 上搜索此类功能，但到目前为止一无所获。

Answer 1

在大多数情况下，文档会生成，但由于警告，它是不完整的。我看到了一些可能性：

• 为此，存在配置设置WARN_AS_ERROR（请参阅：http://www.doxygen.nl/manual/config.html#cfg_warn_as_error）。可能的缺点是遇到警告时进程直接停止。
• 捕获文件中的警告并计算它们/查看文件是否 为空并根据此决定构建是否成功 不是。

编辑

正如@inkychris 所指出的，WARN_AS_ERROR 在 doxygen 版本 1.9.0 中具有FAIL_ON_WARNINGS 的可能性。来自文档：

WARN_AS_ERROR

如果WARN_AS_ERROR 标签设置为YES，那么当遇到警告时 doxygen 将立即停止。如果WARN_AS_ERROR 标签设置为FAIL_ON_WARNINGS，那么 doxygen 将继续运行，就像WARN_AS_ERROR 标签设置为 NO，但在 doxygen 进程结束时，doxygen 将返回 具有非零状态。

可能的值为：NO、YES 和 FAIL_ON_WARNINGS。