linux环境下doxygen使用方法

linux 环境下 doxygen 使用方法

1、安装

sudo apt-get install doxygen graphviz doxygen-latex latex-cjk-*

• doxygen 主要的处理程序
• graphviz 生成如类继承关系的图片
• doxygen-latex 用于将doxygen输出的latex转换为pdf
• latex-cjk-* 转换pdf时，对中文字体的支持

2、生成doxygen的配置文件

doxygen -g ./xxx

上述命令将在当前路径下生成xxx文件，该文件内包含默认的doxygen配置
如果不指定配置文件名称，则生成的文件默认为 Doxyfile

3、针对项目修改配置文件

需要设置的主要分为：文档格式、项目输入文件、输出文档类型
详细的配置内容可以参考doxygen配置选项描述
doxygen的使用和代码注释规范

文档格式

• DOXYFILE_ENCODING 文档编码格式，默认UTF-8
• PROJECT_NAME 项目名称
• PROJECT_NUMBER 项目版本

项目输入文档

• INPUT 代码目录路径，也可以是单个文件，为空时表示当前文件夹
• FILE_PATTERNS 对输入的目录中的文件进行筛选，只有符合的才会被处理
• EXTENSION_MAPPING 对输入的目录中的文件做排除处理
• RECURSIVE 是否递归查找输入文件

输出文档类型

• OUTPUT_LANGUAGE 输出文档语言，中文需要设置为 Chinese
• OUTPUT_DIRECTORY 输出文档路径

4、运行doxygen

doxygen xxx

xxx 为步骤3修改后的配置文件
此时在输出目录中，已经有html和latex两个目录，通过打开html/index.html即可在浏览器中查看文档

5、生成pdf

修改配置文件

因为doxygen生成的latex是没有中文包支持的，所以需要对latex/refman.tex文件进行修改
具体为：

• 在 % Packages required by doxygen 后添加 \usepackage{CJKutf8}
• 在 \begin{document} 后添加 \begin{CJK}{UTF8}{gbsn}
• 在 \end{document} 前添加 \end{CJK}

修改可参考LaTeX Error: Unicode character解决方法

注：{gbsn} 为中文字体格式，可以根据需求调整，但需要在步骤1中有安装

执行生成动作

latex 目录下有 Makefile ，在其路径下执行 make 即可
生成的pdf文件为 refman.pdf