Doxygen生成TensorFlow代码文档

0. 环境

Debian 8.8 x86_64

1. 安装doxygen和graphviz

这是生成代码文档需要的两个组件。前者不必说了,后者是用来画图的(UML图,函数调用图)。

graphviz可直接apt安装:

apt-get install graphviz

下面讨论两种方式安装Doxygen。

1.1 最简单可以从源安装:

apt-get install doxygen

Debian 8 源里的版本比较老,是1.8.8的(截至2017.06.16)。发现的问题是其不支持github风格的markdown code block标记(```)。翻阅Change Log,发现其从1.8.10版本才开始支持这种风格(发布于2015.6.27),并且在1.8.11版本(2015.12.30)中修复了于此有关的Bug,所以推荐至少用1.8.11版本,因而编译安装是更好的方式。

更新:在最新Debian 9 的源中(2018-12),Doxygen的版本是1.8.13,已经可以直接从源里安装了。

1.2 编译安装

解决依赖:

apt-get install flex

下载代码并编译安装。依次执行:

git clone https://github.com/doxygen/doxygen.git
cd doxygen

mkdir build
cd build

cmake -G "Unix Makefiles" ..
make
make install

2. 在代码目录下生成配置文件Doxyfile

doxygen -g

生成Doxyfile后修改:

PROJECT_NAME            = "Tensorflow 1.0"
CREATE_SUBDIRS          = YES
EXTRACT_ALL             = YES
EXTRACT_PRIVATE         = YES
EXTRACT_PACKAGE         = YES
EXTRACT_STATIC          = YES
EXTRACT_ANON_NSPACES    = YES    #匿名命名空间
RECURSIVE               = YES
DISABLE_INDEX           = NO
GENERATE_TREEVIEW       = YES
GENERATE_LATEX          = NO
MACRO_EXPANSION         = YES
EXPAND_ONLY_PREDEF      = YES
PREDEFINED              = GUARDED_BY(x)= \
                          TF_DISALLOW_COPY_AND_ASSIGN(x)= 
EXPAND_AS_DEFINED       = GUARDED_BY    #无效可删
HAVE_DOT                = YES
UML_LOOK                = YES
UML_LIMIT_NUM_FIELDS    = 20  #按需调整,可以再加大些
CALL_GRAPH              = YES    #生成调用图
CALLER_GRAPH            = YES    #生成被调用图

3. 生成html文档

doxygen Doxyfile

这样生成的文档会保存在html文件夹下,主页为index.html

4. 相关项目主页

发表评论

电子邮件地址不会被公开。 必填项已用*标注