doxygen笔记
Doxygen是一个自动生成文档的工具,支持C、C++、Java、Objective-C和IDL语言。只要在代码注释时遵循指定规则,就可以用该工具自动生成说明文档。可生成的文档格式包括HTML、XML、LaTeX、RTF、Unix Man Page,而其中还可衍生出不少其它格式。HTML可以打包成CHM格式,而LaTeX可以透过一些工具产生出PS或是PDF文档。
1.安装
Graphviz:http://www.graphviz.org/download/
doxygen: http://sourceforge.net/projects/doxygen/
doxygen直接安装,主要使用doxywizard,而Graphviz的bin目录加入到系统环境path
2.使用
简单示例:(推荐b站)
https://www.bilibili.com/video/BV1ZE411F7kW?p=5
https://www.cnblogs.com/tianzhijiexian/p/4392924.htm
常用的命令:
doxygen增加图片:
doxywizard生成添加属性 IMAGE_PATH = ./doc/images 相对工程目录
代码加入:@image 图片路径(性对于IMAGE_PATH )
比如@image opencv-orb.png
简单运行结果:(以ORBSLAM2代码为例)