20200805 Ubuntu Doxygen 生成文档简单说明

更多用法，官方文档

//! xxx
类似
//! \brief xxx

/*!
	xxxx //可以在界面中显示 more 这样的连接
*/

\brief 介绍
\remark 备注
\param 参数介绍
\see \sa xxx() 链接某个函数

//!< 变量介绍
int a; //!< xxxx

同时支持 MarkDown 语法

doxygen gui 可直接下载通过命令行的方式

sudo apt install doxygen-gui

启动 运行 doxywizard

配置

Step1 导出目录
Project name : 生成的工程名字
source code directory: 需要转化的目标文件路径
Scan recursively 递归检索

OUTPUT_LANGUAGE: 语言随意选择

Build 导出的内容选择（EXTRACT_PRIVATE 导出私有类)

点击 Run doxygen 就可以导出内容