用doxygen自动生成文档

1. 添加符合doxygen解析规则的注释

（比如函数说明，函数参数/返回值说明）

用qt-creator可以在函数上方一行键入“/**”，然后直接回车，就可以自动生成默认的格式。

2. 安装doxygen, dot, graphviz

doxygen可以生成html/pdf/rtf，其中rtf效果很差，最好是生成html和pdf。

如果需要生成pdf，则还需要安装texlive-latex-base, texlive-latex-extra

3. doxygen配置文件

doxygen配置文件中的常用选项：

LATEX_HEADER: pdf模板

PROJECT_NAME

PROJECT_NUMBER

PROJECT_BRIEF

PROJECT_LOGO

OUTPUT_DIRECTORY

INPUT： 指定源代码或源代码目录

GENERATE_HTML: 默认输出html，不需要可关闭

GENERATE_LATEX: 默认不输出pdf。

4. 生成文档

doxygen <configfile>

pdf文档生成在latex目录下：refman.tex。

需要进行转换：直接在该目录下make就可以。

或者连续运行：pdflatex refman; makeindex refman.idx; pdflatex refman

如果只运行一遍pdflatex，则生成的pdf中不会含有目录信息(outline)。

转载于:https://www.cnblogs.com/realplay/p/9956513.html