Doxgen可以直接从源代码中抽取注释等内容,生成HTML格式的帮助文档;
Doxgen配合graphviz可以从代码中抽取类的关系图;
Doxgen配合Windows Help Workshop可以将生成的HTML文档合成一个chm帮助文档。
Doxgen、graphviz、Windows Help Workshop的使用可以参考:
https://blog.csdn.net/u010740725/article/details/51387810
https://blog.csdn.net/imgcl/article/details/79480350
https://www.cnblogs.com/peterYong/p/6556706.html
用cmake编译开源代码时,很多都有build_doc这个选项,勾选后需要找到这两个文件的位置:
E:/Program Files/doxygen/bin/doxygen.exe;
E:/Program Files (x86)/graphviz-2.38/release/bin/dot.exe;
cmake自己找不到的话就得手动设置。
我用cmake生成解决方案后再vs的编译过程中出现了两个错误:
1,Doxygen error: failed to run html help compiler on index.hhp
2,When enabling GENERATE_HTMLHELP the tree view (GENERATE_TREEVIEW) should be disabled. I'll do it for you.
第一个错误是Windows Help Workshop安装不正确,首先要保证Windows Help Workshop安装后环境变量设置的路径正确,然后要保证cmake生成的Doxyfile文件中hhc.exe(Windows Help Workshop的应用程序)路径设置正确,cmake一般会默认设置为C:\Program Files (x86)\HTML Help Workshop,与你安装路径不符的话改过来。
第二个错误也是要在Doxyfile文件中改,把GENERATE_TREEVIEW选项改为NO就可以了。