基于STM32的Doxygen使用简明手册
为了能使代码能够被Doxygen识别,必须遵循Doxygen的书写规则。注释必须以/**打头,以*/结束。
一、添加类型
1、 添加首页(mainpage):
格式:
/**
\mainpage RIOM DSP Software Library
*
* <b>Introduction</b>
*
* This user manual describes the CMSIS DSP software library
*/
关键字:
\mainpage
描述:
用以显示在首页中,一般用于对整个工程进行描述。
2、 添加define分组(defgroup):
格式:
/** @defgroup ZHM2
* @{
*/
#define XXX YYY
/**
* @}
*/
关键字:
@defgroup name
@{
@}
描述:
定义一个define分组,用以显示在生成的文件中,一般多出现在.h文件中。
3、 添加到分组(addtogroup)
格式:
/** @addtogroup STM32F2xx_StdPeriph_Driver
* @{
*/
XXXX
/**
* @}
*/
关键字:
@addtogroup name
@{
@}
描述:
把一些东西添加到某个分组中去,该分组可以定义在其他文件下,