Ubuntu12.04下使用doxygen生成API文档

前段时间公司里做项目要求遵循doxygen文档规范,并且在Windows XP下安装了Doxygen 1.8.4版本,使用起来能查看头文件是否遵循doxygen规范和一些简单的错误,另外还可以根据C或者C++源代码生成对应的API文档,尤其是生成html格式的话就更方便了。

    比如说想查找dbus、glib等源代码的相关API文档,可以使用doxygen工具将下载的开源软件的源代码生成对应的API文档。

   doxygen也有linux的开源版本,下载地址如下:http://sourceforge.net/projects/doxygen/

   doxygen的网址:http://www.stack.nl/~dimitri/doxygen/index.html

http://www.doxygen.org/

Doxygen Manual :http://www.stack.nl/~dimitri/doxygen/manual/index.html

   Documenting the code : http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#docstructure

    如果看不惯英文,暂时可以参考一下百度百科关于doxygen的介绍:http://baike.baidu.com/view/1502693.html

   Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。

一、在Ubuntu12.04下使用apt-get install命令即可安装doxygen命令行工具和相应的GUI工具,命令如下:

sudo apt-get install doxygen

sudo apt-get install doxygen-gui

安装之后在/usr/bin目录下有关于doxygen的三个命令工具:

doxygen(命令行工具)

doxytag

doxywizard(GUI向导工具)

二、在Ubuntu12.04下使用doxygen将下载好的源代码生成API文档。 1、以从blfs网站http://www.linuxfromscratch.org/blfs/view/svn/general/dbus.html下载源代码D-Bus-1.6.10,链接为:http://dbus.freedesktop.org/releases/dbus/dbus-1.6.10.tar.gz,这个网站有很多现成的linux常用软件。

2、Ctrl+Alt+T打开终端,输入doxywizard,会弹出如下的doxygen GUI界面,这个使用起来和Windows XP下使用的doxygen差不多。

2、将刚下载的dbus-1.6.10.tar.gz解压缩

进入dbus-1.6.10.tar.gz下载所在目录,使用如下命令解压:

tar -xzvf dbus-1.6.10.tar.gz

或者选择dbus-1.6.10.tar.gz点击右键,选择【Extract here】即可。

3、配置dbus工程的选项,例如:doxygen脚本配置文件存放路径、doxygen API文档存放路径、工程名、版本号等信息。

在工作目录,例如/home/ccf/Downloads下创建tmp目录存放doxygen脚本配置文件,创建dbus-html-docs目录用于存放输出的dbus API文档,另外将解压缩后的dbus-1.6.10源代码也移动到此目录下,在第1步弹出的doxygen gui界面中进行如下配置:

从上面的配置可以看出:

doxygen API配置脚本存放路径为:/home/ccf/Downloads/tmp

工程名称为:dbus

版本号为:1.6.10

源代码所在目录为:/home/ccf/Downloads/dbus-1.6.10

doxygen API文档输出路径:/home/ccf/Downloads/dbus-html-docs

另外,注意上面的【Scan recursively】单选框一定要选上,否则生成不了对应的doxygen API文档。

4、运行配置脚本,生成doxygen文档

选择run tab页,然后单击Run doxygen 按钮生成doxygen API文档,如下图所示:

5、查看生成的 dbus API文档参考手册,

可以直接单击第4步Run doxygen Tab页的【Show HTML output】按钮,查看dbus API html格式的文档。

或者直接进入dbus API文档结果输出目录,进入html目录下,即/home/ccf/Downloads/dbus-html-docs/html/,找到index.html并双击打开,如下所示:

可以看到有关dbus API的信息,dbus的介绍、模块、类、文件等说明。

这个还有一个Doxywizard命令工具的Mac GUI使用说明,可以对照着Ubuntu12.04看一下,发现Windows下、Ubuntu12.04下、Mac下的Doxygen工具界面都差不多,使用上也大同小异,网址为:http://www.stack.nl/~dimitri/doxygen/manual/doxywizard_usage.html

以后下载源代码,如果找不到官方的说明文档,或者说网上介绍得不够详细,可以使用doxygen生成相应的API参考手册,不过前提最好是写的文档符合doxygen代码规范哦!

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

扫码关注云+社区

领取腾讯云代金券