Doxygen c++接口文档,生成pdf

注:本文不介绍代码接口注释写法。

DoxyWizard

我使用的是windows下的doxyWizard,界面如下所示:

image.png

step1

选择Doxygen工作目录。此处我直接选择工程目录,这样会在工程目录下生成一个doxyfile,以后再使用doxygen为此工程创建接口文档时,可以直接使用doxyWizard打开工程目录下的doxyfile恢复相关的设置。
总之是为了将这个Doxygen设置作为项目一部分,方便以后使用。

step2

  1. 根据界面提示设置好源文件的目录,以及接口文档的生成目录。如果只想为接口代码生成接口文档,建议将接口代码放到单独目录里,再将其设置为源文件的目录。
  2. 其他保持默认,直接进入到Expert标签下:


    1 设置语言和编码

2 设置导出选项

只有设置上面Extract_all这个选项才能识别如下的全局using语句

using LaneInfoSConstPtr = std::shared_ptr;

3 HTML树状导航

设置以上选项,HTML会生成侧边的树状导航栏。

  1. 完成以上选项,切换到Run标签栏,点击Run doxygen,完事儿。

Doxygen主页内容设置

打开生成的html文件,会发现主页大片空白没有内容。


主页

如上图所示,如果主页空白部分能有基本的使用说明最好不过了。
为主页添加内容也很简单,打开一个接口代码文档,加入以下注释:

/*! \mainpage 主页
# 简介
一些描述。
# Quick Start
一些使用说明。
 */

可以看出,我们注释的内容使用了MarkDown的语法。
然后重新生成接口文档,再打开看一下:


主页

可以看到,主页有内容了。

生成pdf

有时项目中仍然需要提交word或者pdf的文档,所以还需要生成一份pdf格式的接口文档。
这里使用的工具是 MikTex ,安装参考:
https://blog.csdn.net/Yonggie/article/details/97965554
安装好之后,将安装目录下的bin目录添加到环境变量path里面去!比如我的安装目录:
D:\Program Files\MiKTeX\miktex\bin\x64,这个目录下面有一个pdflatex.exe的可执行程序,它就相当于编译器!

然后进入接口文档生成目录latex目录下。你会发现整个目录下面有一个makefile文件,是不是知道该怎么做了。感兴趣可以打开makefile文件看一下,实际上就是用pdflatex.exe去编译latex目录下面的文件。
在此目录下打开命令行终端(cmd),直接输入make命令,会在该目录下编译生成pdf文件。

你可能感兴趣的:(Doxygen c++接口文档,生成pdf)