这个是生成文档的类型的选项,默认生成html和latex,共支持六种类型的文档,每种类型的生成配置也是很多,具体根据需要配置
GENERATE_HTML
GENERATE_LATEX
GENERATE_RTF
GENERATE_XML
GENERATE_DOCBOOK
GENERATE_MAN
关于生成图像的选项.doxygen使用dot这个工具来绘图,所以要先执行sudo apt-get install graphviz安装dot.在设置好这个绘图选项之后,doxygen就会生成各个结构体的关系,对于类会生成函数调用关系(我没试过,因为只试过C的).
HAVE_DOT (一定要置为YES,后面的选项都依赖这个)
DOT_NUM_THREADS (使用dot绘图的线程数量,越多越快,我一般是设置跟cpu的核数一样)
//以下两个选项跟生成函数调用关系图有关
CALL_GRAPH
CALLER_GRAPH
EXTRACT_ALL //把所有实体都输出到文档,不管它是否能被描述
EXTRACT_STATIC //把静态变量也输出到文档中
EXTRACT_PRIVATE //把私有变量也输出到文档中
给一个结构体关系图,就是doxygen生成的.
关于源码搜索路径,默认是搜索本目录的源代码,大部分情况下源码是分布在各个子目录的.
RECURSIVE = YES
默认RECURSIVE是NO,所以记得把它设置为YES,递归搜索子目录. 感谢soglad的留言提醒
最后一步,在源码根目录执行doxygen,它会自动找到Doxygen配置,根据配置生成文档.
gdb
最后一个工具,大名鼎鼎的gdb.分析源码执行流程的最好方式的是运行它,然后一步步执行.用来观察它最好的工具当然是gdb了(针对C/C++).
gdb的使用我也不打算造轮子,直接参考用GDB调试程序,这篇写的很好,通俗易懂.
后记
以上就是我在阅读源码的时候使用的Linux工具,三剑客vim+ctags+cscope,两板斧doxygen gdb,足以驰骋源代码的江湖.
以上工具,vim和gdb是最难学的,学习曲线很陡峭.但是学好之后,就能守得云开见月明.
