doxygen 的安装、配置、编译及使用(从源代码到文档)

doxygen 的安装、配置、编译及使用(从源代码到文档)

1. 什么是 doxygen

下面是 doxygen 主页上的一段说明文字

Source code documentation generator tool

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

简单地说，doxygen 能够自动分析源代码并从源代码中抽取相应的注释，整理成文档。

它的好处是源代码与文档同步，易于维护

下面以 Fedora 10 和 doxygen 1.5.8 为例来说明其安装和使用

2. 安装

a. 下载源代码

点击进入 下载页面

b. 下载用户手册

点击进入 下载页面

这里面的内容很详细，从下载、编译、安装、使用都写得很清楚

c. 编译

这是linux下标准的安装方式

首先用tar命令 解压源代码，然而用cd命令进入解压后的文件夹，

运行 ./configure --help 查看配置

运行 ./configure --enable-langs --with-doxywizard --with-doxyapp 进行配置

编译 make

安装 make install

3. 使用

doxygen 生成文档的基本方式是先生成一个配置文件，告诉doxygen如何去生成文档，然后让doxygen生成文档。由于doxygen的配置文件选项有很多， 因此我们通常是让doxygen先生成一个默认的配置文件，再修改其中的一些选项，生成自己的配置文件。

a. 生成默认配置文件

首先用 cd 命令，进入 源代码所在的文件夹

然后运行 doxygen -g 命令，生成 默认的配置文件

因为没有指定配置文件的文件名，因此生成的默认配置文件 自动命名为 Doxyfile

b. 修改配置选项

用任何一种文本编辑器，打开 Doxyfile 文件

下面是一些配置选项及说明

RECURSIVE = YES   这可以让doxygen从配置文件所在的文件夹开始，递归地搜索所有的子目录及源文件

SOURCE BROWSER = YES 这会在最后生成的文档中，把所有的源代码包含在其中

INLINE SOURCES ＝ YES 这会把函数的实现部分的代码包含在每个函数的说明部分，可以方便地查看函数的实现方式，但会让整个文档显得有些凌乱，故不推荐使用

GENERATE TREEVIEW ＝ ALL 这会在HTML文档中，添加一个侧边栏，并以树状结构显示包、类、接口等的关系

GENERATE_LATEX = NO 这个设置将导致doxygen不生成pdf文档，不太喜欢pdf文档，把它关了吧

c. 生成文档

运行 doxygen Doxyfile 命令，生成文档

d. 查看文档

在 html 文件夹下，找到 index.html 文件，用浏览器，打开它，就可以查看生成的文档了 ^_)^