doxygen把stm32的代码转换成文档的教程（1）

doxygen把stm32的代码转换成文档的教程（1）

一.doxygen的介绍

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞泰坦尼克号同样的辛苦。大部分有用的批注都是属于针对函数、类型等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。

二.doxygen的下载和安装

1.这个软件最好去官网下载：官网地址

2.windows的安装过程很简单，一步步安装就行了。
linux下面的安装稍微有点麻烦，按照下面的命令一步步安装即可：

git clone https://github.com/doxygen/doxygen.git
cd doxygen
mkdir build
cd build
cmake -G "Unix Makefiles" ..
make
make install

至于苹果版的就不清楚了，因为我没有苹果电脑。

三.doxygen的使用

1.配置项目：

2.配置模式：

3.配置输出：
4.配置图表：

参考资料：
1.使用doxygen生成的帮助文档，中文出现乱码的问题。
2.doxygen+VIM文档实用指南for C/C-liked Programmers。
3.Doxygen给C程序生成注释文档。
4.嵌入式C语言中的Doxygen注释模板 。
5.让Doxygen输出中文注释不乱码。
6.使用doxygen为C/C++程序生成中文文档（上）。