提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
前言
Doxygen 是一个程序的文件产生工具,可将程序中的特定注释转换成为说明文件。大部分有用的注释都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将注释经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。
对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等
在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。
一、先安装支持工具
1、安装gcc和g++:
安装gcc并查看版本
sudo apt-get install build-essential
gcc --version
安装同一版本的g++:
sudo apt-get install g++-x.x
g++ --version
如果报错,那么:
sudo apt update
sudo apt upgrade
2、安装python、cmake、Bison & Flex:
sudo apt install cmake
sudo apt-get install flex bison
二、安装最新版本的Doxygen
git clone https://github.com/doxygen/doxygen.git
cd doxygen
接下来:
mkdir build
cd build
cmake -G "Unix Makefiles" ..
make
To force a fresh build after an earlier check-out simple remove the build directory and redo the steps above.(要在先前签出后强制重新生成,只需删除生成目录并重做上述步骤?)
最后:
sudo make install
参考
操作手册:https://www.doxygen.nl/files/doxygen_manual-1.9.4.pdf.zip
官网:https://www.doxygen.nl/index.html