博客迁移已迁移到https://www.guyuemeng.com
概述
基础章节主要介绍了doxygen的基本语法,用于注释类、成员、函数等,由此可以生成含有注释的文档。但在拥有基本注释内容的基础上,面对大量注释,希望可以合理的分类以及布局,即本文将介绍的doxygen分组方法。
模块(modules)
模块的划分会显示在CHM文件中的目录树上,每个模块将单独作为一页显示。这里将着重介绍@defgroup、@addtogroup、@{…@}、@ingroup
defgroup
模块定义的唯一方式,可以是纯定义,也可以定义时初始化模块内容:
1.纯定义
/**
* @defgroup [gTag] [gName]
* This is brief.
* This is detail.
*/
2.定义+初始化
/**
* @defgroup [gTag] [gName]
* This is brief.
* This is detail.
* @{
*/
...
/** @} */
1.模块的定义语句包含了三部分CMD+TAG+NAME,如上所示: