Ubuntu中利用Doxygen生成开源程序包的API文档

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

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

蓝亦

感谢博主辛勤的付出

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值