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;
}

我曾尝试在互联网上搜索此类功能，但到目前为止还没有找到任何功能。

Answer 1

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

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

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

1 个答案: