网上已经有大量详细的资料了,但是我找了好久也没找到安装配置完doxygen之后,怎样才能生成文档,遂记下此篇,便于以后查找。
安装Doxygen
1 | sudo apt-get install doxygen |
doxygen使用dot这个工具来绘图,所以要安装dot
1 | sudo apt-get install graphviz |
在设置好这个绘图选项之后,doxygen就会生成各个结构体的关系,对于类会生成函数调用关系.
Doxygen注释语法
因为网上比较多,这里就不再赘述,只给出几篇我看到的好文章。
Doxygen简明注释语法 ( 这个主要是注释的语法)
Ubuntu 下使用 Doxygen (这个讲了一点doxygen的原理)
Ubuntu16.04安装与使用Doxygen(这个里面有很多关于doxygen的文章链接)
生成文档的方法
举个例子
给这个文件夹里的文件生成注释文档
在这个文件夹里打开终端,输入指令
1 | doxygen -g |
该文件夹里会生成一个名为Doxyfile的文件
然后再输入
1 | doxygen Doxyfile |
就会生成一个html文件和一个latex文件
打开html文件夹里的xxx_8h.html文件
效果如下图