ubuntu 下使用doxygen为C/C++工程生成pdf版的API

本文详细介绍了如何使用Doxygen生成源代码文档,包括安装必要软件、配置Doxyfile、生成及修改Latex文件等内容,帮助开发者快速掌握文档自动生成技巧。

1. 安装doxygen相关软件

sudo apt-get install doxygen

sudo apt-get install graphviz

来安装相应的工具。
    安装完成后,先参考IBM的 学习用 doxygen 生成源码文档
    现在,我们开始让Doxygen为我们工作了。
2.生成配置文件Doxyfile

在shell中运行doxygen -g,在当前目录产生Doxyfile,该配置文件全部是默认值;
3. 修改配置文件(文件很长):

给自己的工程取个名吧
PROJECT_NAME           = Hello
做个版本号标识
PROJECT_NUMBER         = 1.0
文档输出路径一定要设置
OUTPUT_DIRECTORY       = /yourpath
产生的文档文件分子目录,否则一个目录下会有巨多的文件,烦!
CREATE_SUBDIRS         = YES
我是不喜欢在文件中显示文件的全路径:)
FULL_PATH_NAMES        = NO
SHORT_NAMES            = YES
文档显示方法问题,我喜欢这种风格
JAVADOC_AUTOBRIEF      = YES
这两个是针对C和JAVA的信息输出优化
OPTIMIZE_OUTPUT_FOR_C  = YES
OPTIMIZE_OUTPUT_JAVA   = YES
将哪些符号、函数等导出
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_METHODS  = YES
对于没有名字域区别的C,还是选上这种吧
EXTRACT_ANON_NSPACES   = YES
源代码输入路径
INPUT                  = /yourpath
哪些文件选入Doxygen的范围,不选就是默认的C和C++的文件类型
FILE_PATTERNS          =
当然递归识别我指定路径下的源代码
RECURSIVE              = YES
我喜欢在文档中浏览源代码
SOURCE_BROWSER         = YES
为制作CHM作准备,只是制作CHM好像只有在Windows下
GENERATE_HTMLHELP      = YES
喜欢LATEX,也喜欢HTML
GENERATE_LATEX         = YES
GENERATE_HTML          = YES
图表化调用关系等
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
Ubuntu下不用指定的,安装graphviz后,自动加入到shell环境变量中了。
DOT_PATH               = /usr/bin
你想描绘的调用关系的深度,好像5级比较合适
MAX_DOT_GRAPH_DEPTH    = 5

4. 现在执行doxygen Doxyfile就可以看结果了

5. 安装中文latex环境

首先安装texlive(额, 这个有点大, 我装的时候提示几百兆)

sudo apt-get install texlive-full 

然后安装cjk的一些东西

sudo apt-get install latex-cjk-chinese*
sudo apt-get install cjk-latex

6. 修改前面doxygen Doxyfile生成的latex文件:refman.tex

将其中的:

\begin{document}

改为:

\usepackage{CJKutf8}
\begin{document}
\begin{CJK}{UTF8}{gbsn}

并将其中的:

\end{document}

改为:

\end{CJK}
\end{document}

以上操作是声明使用CJKutf8的包, 并用CJK将document段括起来.

7. 在latex文件夹下执行make就行了,找到输出的pdf文件。

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值