Doxygen 的使用

1. 安装

• OS X

$ brew install doxygen
$ brew install graphviz

• Ubuntu/Debian

$ sudo apt-get install doxygen
$ sudo apt-get install graphviz

2. 使用方法

• 生成配置文件

doxygen -g

会在当前目录下生成一个 DoxyFile 文件

• 修改配置
  修改 DoxyFile 文件，主要修改以下几项：
  CALL_GRAPH = YES
HAVE_DOT = YES
RECURSIVE = YES （递归检索文件）
  过滤不必要的目录

EXCLUDE_PATTERNS = */.git/*
EXCLUDE_PATTERNS += */docs/*
EXCLUDE_PATTERNS += */test/*

• 生成

doxygen DoxyFile

执行完成后可以在当前目录下看到一个 html 目录和 latex 目录，直接打开 html/index.html 即可看到结果。