Ubuntu中利用Doxygen生成开源程序包的API文档
来源:互联网 发布:淘宝手机删除差评步骤 编辑:程序博客网 时间:2024/06/10 19:22
Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。
在Ubuntu下使用apt-get install命令即可安装doxygen命令行工具和相应的GUI工具,命令如下:
sudo apt-get install doxygen
sudo apt-get install doxygen-gui
操作步骤:
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、打开终端,输入doxywizard
3、将刚下载的dbus-1.6.10.tar.gz解压缩
4、配置dbus工程的选项,例如:工程名、版本号和开源程序包存放路径、doxygen API输出文档存放路径等信息。
注意上面的【Scan recursively】单选框一定要选上,否则生成不了对应的doxygen API文档。
5、运行配置脚本,生成doxygen文档。选择run tab页,然后单击Run doxygen
6、直接进入dbus API文档结果输出目录,进入html目录下,即文档输出目录,找到index.html并双击打开,
(引自 http://blog.csdn.net/ccf19881030/article/details/9098041)
- Ubuntu中利用Doxygen生成开源程序包的API文档
- 部署Doxygen生成API文档
- 利用doxygen生成python文档
- ns3使用doxygen生成离线api文档
- C++工程 API文档生成-doxygen
- ns3使用doxygen生成离线api文档
- API文档生成工具——Doxygen
- 如何利用doxygen生成pdf文档
- 如何利用doxygen生成pdf文档
- 利用doxygen 生成antlr C++ API
- ubuntu下,使用doxygen生成文档
- Ubuntu系统使用Doxygen生成文档
- Doxygen文档生成工具的使用
- Doxygen文档生成工具的使用
- Doxygen文档生成工具的使用
- doxygen的文档生成,注释规范
- Ubuntu12.04下使用doxygen生成API文档
- 使用 doxygen 生成文档
- LINUX7安装oracle12C遭遇ins_precomp.mk报错
- poj 2387 最短路 spfa 实现
- Android学习(3)TextView和EditView
- C++ primary 第四版3.8习题解答
- 关于苹果的证书问题
- Ubuntu中利用Doxygen生成开源程序包的API文档
- 博主应Autodesk邀请,以2D到3D的跨越为主题做网络讲座(4.23号下午)
- java中String类与变量相加解释一旦创建了String对象,那它的值就无法改变了
- 在MyEclipse中安装SWT/Swing设计器
- C++设计模式之原型模式
- Spark故障排除
- Project Euler Solutions(Problem 1~7)
- 根据经纬度获取两点之间的距离(php&mysql)
- android:软件的安装和卸载源代码