安装完成后,先参考IBM的 学习用 doxygen 生成源码文档。
现在,我们开始让Doxygen为我们工作了。
1、在shell中运行doxygen -g,在当前目录产生Doxyfile,该配置文件全部是默认值;
2、修改你应该关心的部分:
给自己的工程取个名吧
PROJECT_NAME = Hello
做个版本号标识
PROJECT_NUMBER = 1.0
文档输出路径一定要设置
OUTPUT_DIRECTORY = /yourpath
产生的文档文件分子目录,否则一个目录下会有巨多的文件,烦!
CREATE_SUBDIRS = YES
我是不喜欢在文件中显示文件的全路径:)
FULL_PATH_NAMES = NO
SHORT_NAMES = YES
文档显示方法问题,我喜欢这种风格
JAVADOC_AUTOBRIEF = YES
这两个是针对C和JAVA的信息输出优化
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = YES
将哪些符号、函数等导出
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_METHODS = YES
对于没有名字域区别的C,还是选上这种吧
EXTRACT_ANON_NSPACES = YES
源代码输入路径
INPUT = /yourpath
哪些文件选入Doxygen的范围,不选就是默认的C和C++的文件类型
FILE_PATTERNS =
当然递归识别我指定路径下的源代码
RECURSIVE = YES
我喜欢在文档中浏览源代码
SOURCE_BROWSER = YES
为制作CHM作准备,只是制作CHM好像只有在Windows下
GENERATE_HTMLHELP = YES
不喜欢LATEX,我喜欢HTML
GENERATE_LATEX = NO
GENERATE_HTML = YES
图表化调用关系等
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
Ubuntu下不用指定的,安装graphviz后,自动加入到shell环境变量中了。
DOT_PATH = /usr/bin
你想描绘的调用关系的深度,好像5级比较合适
MAX_DOT_GRAPH_DEPTH = 5
3、现在执行doxygen Doxyfile就可以看结果了。