ubuntu16.04使用doxygen(带生成文档的方法)

网上已经有大量详细的资料了,但是我找了好久也没找到安装配置完doxygen之后,怎样才能生成文档,遂记下此篇,便于以后查找。

安装Doxygen

sudo apt-get install doxygen

doxygen使用dot这个工具来绘图,所以要安装dot

sudo apt-get install graphviz

在设置好这个绘图选项之后,doxygen就会生成各个结构体的关系,对于类会生成函数调用关系.

Doxygen注释语法

因为网上比较多,这里就不再赘述,只给出几篇我看到的好文章。
Doxygen简明注释语法 ( 这个主要是注释的语法)
Ubuntu 下使用 Doxygen (这个讲了一点doxygen的原理)
Ubuntu16.04安装与使用Doxygen(这个里面有很多关于doxygen的文章链接)

生成文档的方法

举个例子
给这个文件夹里的文件生成注释文档
在这里插入图片描述在这个文件夹里打开终端,输入指令

doxygen -g

该文件夹里会生成一个名为Doxyfile的文件
然后再输入

doxygen Doxyfile

就会生成一个html文件和一个latex文件

在这里插入图片描述打开html文件夹里的xxx_8h.html文件
在这里插入图片描述效果如下图
在这里插入图片描述

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值