Doxygen使用指导

1 doxygen简单说明

doxygen这款工具我就不细说了，总的来说会将代码中的结构体和函数都解析出来，然后会已网页等形式展现，里面我们最关心的是：结构体之间的包含关系、函数之间的调用关系。
官方指导页面在这里：https://www.doxygen.nl/index.html。
他能够支持C/C++,JAVA,Python等一系列语言，然后生成一些html/pdf之类的页面给大家去读取。

2 如何利用doxygen

这么一个好工具，肯定大家都希望用来的，而且这里面用到的规格也比较简单。但是比较遗憾的是，目前很多人写代码没有按照规定的代码注释风格来写，所以doxygen不一定能够正常工作。
注释是一个比较重要的地方，比如：

2.1 头文件的注释

/** @brief   这里写你的摘要
 *  @file    你的文件名
 *  @author  作者
 *  @version 版本
 *  @date    日期
 *  @note    注解. 例如: 本文件有什么具体功能啊, 使用时要注意什么啊..
 *  @since   自从...
 */

2.2 函数的注释

/**  这里写这个函数的概述
 @param[in]  输入参数1
 @param[in]  输入参数2
 @param[out] 输出参数1
 @return     返回值解释一下
 @warning    警告: 例如: 参数不能为空之类的
 @note       注解
 @see        类似于请参考xxoo函数之类的
*/

2.3 行注释

/**< 在这里写你要加的东西 */
OR
///< 在这里写你要加的东西

3 安装方法

不细说别的，就说Linux下面怎么安装，Ubuntu直接安装就可：

sudo apt install doxygen

安装了这个，不安装 graphviz 就有点浪费了，如果要生成各种图以及调用关系，就必须要有这个工具。

sudo apt install graphviz

4 使用方法

进入scp-firmware代码根目录，执行这个代码生成默认配置。

doxygen -g config-scp-firmware