将正确的doxygen文档作为构建要求 我正在使用DoXEGEN来记录一个越来越大的C++项目,我一直在想如何才能使Doxygen成为项目的构建需求。换句话说,如果没有为Doxygen成功记录任何类/方法/等,我希望我的构建过程失败并停止。我使用make进行建筑
例如,我希望此操作失败(即不构建):将正确的doxygen文档作为构建要求 我正在使用DoXEGEN来记录一个越来越大的C++项目,我一直在想如何才能使Doxygen成为项目的构建需求。换句话说,如果没有为Doxygen成功记录任何类/方法/等,我希望我的构建过程失败并停止。我使用make进行建筑,doxygen,Doxygen,例如,我希望此操作失败(即不构建): /** *@bbrief Oops,标记不存在,发出警告,因此生成失败。 */ void f() { //做点什么。。。 } /** *@程序X的简短主要功能 * *@返回执行结束状态。 * * ... * */ int main() { f(); 返回0; } 但这需要建立: /** *@brief好的,这很好。 * */ void f() { //做点什么。。。 } /** *@程序X的简短主要功能 * *@返回执行结束状态。 * * ... * */
/**
*@bbrief Oops,标记不存在,发出警告,因此生成失败。
*/
void f()
{
//做点什么。。。
}
/**
*@程序X的简短主要功能
*
*@返回执行结束状态。
*
* ...
*
*/
int main()
{
f();
返回0;
}
但这需要建立:
/**
*@brief好的,这很好。
*
*/
void f()
{
//做点什么。。。
}
/**
*@程序X的简短主要功能
*
*@返回执行结束状态。
*
* ...
*
*/
int main()
{
f();
返回0;
}
我曾尝试在Internet上搜索此类功能,但迄今为止没有找到任何内容。在大多数情况下,文档是生成的,但由于警告,文档不完整。我看到了一些可能性:
- 为此,存在配置设置
(请参阅:)。可能的缺点是,当遇到警告时,进程会直接停止WARN\u AS\u ERROR
- 捕获文件中的警告并计数/查看该文件是否正确 空,并基于此确定构建是否成功 不是
make
是否有办法知道Doxygen停止是因为它产生了警告,而不是因为它完成了正常生成?通常,Doxygen返回0,如果出现错误,它返回1(如果子进程分叉,它也可能返回错误a 127)