Doxygen
1.1、Doxygen简介
是什么 ?:a tool that generates documentation from annotated source code.
开发语言:C
官方主页:http://doxygen.nl
源码仓库:https://github.com/doxygen/doxygen
1.2、通过包管理器安装Doxygen
操作系统包管理器安装命令
Windowsscoopscoop install doxygen
WindowsChocolateychoco install -y doxygen.install
macOSHomeBrewbrew install doxygen
GNU/LinuxLinuxBrewbrew install doxygen
aptsudo apt-get install -y doxygen
CentOSyumsudo yum install -y doxygen
dnfsudo dnf install -y doxygen
openSUSEzyppersudo zypper install -y doxygen
Alpine Linuxapksudo apk add doxygen

Arch Linux

ArcoLinux

Manjaro Linux

pacmansudo pacman -Syyu --noconfirm
sudo pacman -S    --noconfirm doxygen
Gentoo LinuxPortagesudo emerge doxygen
1.3、通过源码安装Doxygen 

1、安装依赖

下载时cURL
解压时targzip
编译时cmakemakegccbison
运行时glibc ( libc.sold-linux-x86-64.so )

step2、使用curl命令下载Doxygen源码包 (

curl -LO http://doxygen.nl/files/doxygen-1.8.16.src.tar.gz

step3、使用tar解压Doxygen源码包

tar vxf doxygen-1.8.16.src.tar.gz

step4、进入doxygen-1.8.16目录

cd doxygen-1.8.16

step5、查看doxygen-1.8.16目录的内容

step6、使用cmake配置编译参数

这里常用的cmake的变量如下表:

变量类型默认值说明
CMAKE_C_COMPILERFILEPATH/usr/bin/cc指定C编译器命令
CMAKE_C_FLAGSSTRING设置C编译器命令的参数
CMAKE_CXX_COMPILERFILEPATH/usr/bin/c++指定C++编译器命令
CMAKE_CXX_FLAGSSTRING设置C++编译器命令的参数
CMAKE_INSTALL_PREFIXPATH/usr/local/设置安装目录
CMAKE_BUILD_TYPESTRINGDebug
Debug 编译器设置-g参数
Release 编译器设置-O3 -DNDEBUG参数
RelWithDebInfo 编译器设置-O2 -g -DNDEBUG参数
MinSizeRel 编译器设置-Os -DNDEBUG参数

示例:

cmake \
    -DCMAKE_BUILD_TYPE=Release \
    -DCMAKE_INSTALL_PREFIX=/usr \
    -G "Unix Makefiles" \
    -Wno-dev \
    -S . \
    -B build

说明:

-G "Unix Makefiles"表示配置后会产生makeMakefile文件。

step7、使用make编译、安装

CPUCoreCount=$(grep -c processor /proc/cpuinfo)
jobCount=$((CPUCoreCount + 1))

make --directory=build -j${jobCount} && sudo make --directory=build install
1.4、doxygen命令