Doxygen的使用

原文

http://www-utheal.phys.s.u-tokyo.ac.jp/~yuasa/wiki/index.php/Doxygen%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9

前提

安装doxygen，graphviz

$brew install doxygen

$brew install graphviz

生成配置文件

doxygen -g <filename>

修正配置文件

< EXTRACT_ALL            = NO
--- 提取所有项
> EXTRACT_ALL            = YES

< EXTRACT_PRIVATE        = NO
--- 提取Private项
> EXTRACT_PRIVATE        = YES

< EXTRACT_STATIC         = NO
--- 提取static项
> EXTRACT_STATIC         = YES

< EXTRACT_LOCAL_METHODS  = NO
--- 提取local函数
> EXTRACT_LOCAL_METHODS  = YES

< HIDE_SCOPE_NAMES       = NO
--- 显示名字时，不显示范围名称。如：NamespaceA::ClassB::MethodC会显示成MethodC
> HIDE_SCOPE_NAMES       = YES

< RECURSIVE              = NO
--- 递归的解析子目录
> RECURSIVE              = YES

< SOURCE_BROWSER         = NO
--- 显示源代码列表
> SOURCE_BROWSER         = YES

< INLINE_SOURCES         = NO
--- 显示源代码内容
> INLINE_SOURCES         = YES

< ALPHABETICAL_INDEX     = NO
--- 生成顺序索引
> ALPHABETICAL_INDEX     = YES

< GENERATE_TREEVIEW      = NO
--- 生成树视图
> GENERATE_TREEVIEW      = YES

< CALL_GRAPH             = NO
--- 生成调用图（使用graphviz）。HAVE_DOT需要设置为YES
> CALL_GRAPH             = YES

生成文档

$ doxygen <filename>

查看生成的HTML

 $ open html/index.html

生成PDF

$ cd tex

$ make

$ make pdf

http://www.ibm.com/developerworks/cn/aix/library/au-learningdoxygen/