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)

0 0
原创粉丝点击
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防,我是瞎子 冬天打游戏手冷怎么办 漂流瓶不能用了怎么办 感冒鼻子闻不到味道怎么办 胃难受想吐头晕怎么办 心口窝堵得慌怎么办 嘴巴里苦的很怎么办 怀孕了嘴巴好苦怎么办 嘴巴没味道想吐怎么办 手机流量不够用怎么办移动 sd卡图片不显示怎么办 苹果忘了id账号怎么办 苹果id号忘记了怎么办 7icloud存储满了怎么办 苹果6icloud满了怎么办 电脑内存槽坏了怎么办 苹果7照片删不了怎么办 屋里太冷怎么办小妙招 天气太热,没空调怎么办 8岁儿童发烧39度怎么办 4岁儿童发烧39度怎么办 6岁儿童发烧39度怎么办 手机被晒得很烫怎么办 子宫肌瘤引起的贫血怎么办 月子没做好腰疼怎么办 狗狗屁股流血水怎么办 狗狗屁股在流血怎么办 劳累引起的腰疼怎么办 心口发闷堵的慌怎么办 刨腹产后肚子大怎么办 c盘空间不够用怎么办 敷面膜玩手机了怎么办 领导想辞退我该怎么办 领导要辞退我要怎么办 想辞职老板不批怎么办 辞职后工资不给怎么办 闻组词表示听见怎么办 染完头发后悔了怎么办 跟不好的人相处怎么办 销售时遇到客诉怎么办? 面对挑衅你的人怎么办 我的性格很拘谨怎么办