参考文章:
1 Doxygen简介
1.1 What to do?
使用Doxygen生成文档,主要是两件事:
写一个配置文件(Doxyfile),一般用Doxywizard生成后,再手工修改[不建议使用,不直观,比较麻烦]。或者可以用辅助的GUI工具帮助书写,你只需要改几个选项,点几下按钮就可以了(在下面有介绍)。
按照Doxygen的约定,将代码“文档化”。
如果已经有配置文件(Doxyfile),执行命令:doxygen Doxyfile,就会输入文件、输出目录、参数等都是在Doxyfile中配置好的,在/doc/html/index.html中查看。
1.2 What you want?
Doxygen的输出格式主要有HTML、LATEX、RTF等:
Doxygen在输出HTML文档时,可以自动准备用于制作CHM的项目文件(.hhp)、目录文件(.hhc)和索引文件(.hhk)。用HTML Help Workshop中的CHM编译器(hhc.exe)编译后生成CHM文件。
Doxygen在输出LATEX文档的同时准备了转换到pdf格式的makefile。只要系统安装了合适的TEX工具,就可以从LATEX文档生成pdf文档。
Doxygen输出的RTF格式,已经针对Word作了优化,可以较好地转换到Word文档。
1.3 install
如果你电脑里可能还没有doxygen,我们先来安装一下:
sudo apt-get install doxygen doxygen-gui //就是上面提到的GUI,不用再写Doxyfile,用GUI工具。<