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的配置文件选项有很多,