doxygen生成html文件,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文件，用浏览器，打开它，就可以查看生成的文档了 ^_)^

doxygen生成html文件,doxygen 的安装、配置、编译及使用(从源代码到文档)相关推荐

java 生成word文件怎么打开乱码_word打开是乱码怎么办？word文档打开出现乱码的解决技巧...
word打开是乱码怎么办?word是我们最常使用的办公软件了,最近一位Win7用户反应,word文档打开是乱码,汉语部分没有乱码,而编程代码(java代码)乱码了,这是怎么回事呢?出现这种情况,说明该 ...
详解“FTP文件传输服务”安装配置实例
"FTP文件传输服务"安装配置实例家住海边喜欢浪:zhang789.blog.51cto.com 目录简介 ftp工作原理常见的FTP服务 Vsftpd服务器的安装 Vsft ...
VS2010 打包生成exe文件后运行安装文件出现 TODO:文件说明已停止工作并已关闭
一.VS2010 打包生成exe文件后运行安装文件出现 TODO:<文件说明>已停止工作并已关闭 TODO: <文件说明>已停止工作原因: 打包的时候在文件系统中建立了 ...
Sublime Text 3安装Package Control快速建立html5和xhtml文档
Sublime Text 3安装Package Control快速建立html5和xhtml文档先关闭Sublime text 3: 第1步:下载sublime_package_control-ma ...
jacob.jar 操作word文件添加水印、图片（附查阅Microsoft Office VBA参考文档方式）
jacob.jar 操作word文件添加水印.图片 1.准备jacob.jar包和dll文件将jacob.jar引入到工程, 64位: 将jacob-1.17-M2-x64.dll 放在C:\Wi ...
“Word在试图打开文件时遇到错误。请尝试下列方法：* 检查文档或驱动器的文件权限。* 确保有足够的内存和磁盘空间。* 用文件恢复转换器打开文件。”问题！...
Word在试图打开文件时遇到错误. 请尝试下列方法: * 检查文档或驱动器的文件权限. * 确保有足够的内存和磁盘空间. * 用文件恢复转换器打开文件. 如下图: 让同事在他们自己电脑上,都是可以打开 ...
Word在试图打开文件时遇到错误，请尝试下列方法：检查文档或驱动器的文件权限确保有足够的内存和磁盘空间用文本恢器打开文件
Word在试图打开文件时遇到错误,请尝试下列方法:检查文档或驱动器的文件权限确保有足够的内存和磁盘空间用文本恢器打开文件 . 经常在浏览器上直接下载的文档打开就报这个错,也不知道是什么原因,最后 ...
最近看了很多druid的配置,发现有些云里雾里,自己参考文档写了一份配置,需要的同学自己改吧改吧,有理解错误的地方希望大家指出来
最近看了很多druid的配置,发现有些云里雾里,自己参考文档写了一份配置,需要的同学自己改吧改吧 spring:#数据库配置datasource:#这里使用的是德鲁伊数据库连接池druid:db-ty ...
C++11 文件读写(vs2019 安装配置boost库)
一.VS2019 安装配置boost库 1.库下载 boost v1.75下载: Boost Downloads boost v1.70下载:Version 1.70.0 本文使用boost v1.7 ...

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

doxygen生成html文件,doxygen 的安装、配置、编译及使用(从源代码到文档)相关推荐

最新文章

热门文章