第四章:Grouping归组
Doxygen有两种机制进行归组。第一种是全局级,为每个group创建一个新的page。这些groups在注释中被称作“modules”。另一种机制使用于一些compound entity中的member list,称为“member group”。
Modules模块
Modules是一种归组things在分离的page上的方式。组的成员可以是file,namespace,classes,functions,variables,enums,typedefs和defines,但也可以是其他groups。
要定义一个group,应该在一个特殊注释块放置/defgroup。命令的第一个参数应该是唯一标志该group的标签。要将一个entity归为某个group的一个member,在entity前放置/ingroup命令。第二个参数是group的title。
要避免在注释中每个member前放置/ingroup命令,可以将member用@{ 和@}封装起来。@{@}标记可以放置group的注释中,也可以在一个独立的注释块
使用这些group的标记符号groups也可以嵌套。
如果多次使用一个group标签,将会出错。如果不希望doxygen强行执行唯一标签,可以使用/addtogroup而非/defgroup。运作方式和/defgroup很像,但是如果该group已经定义,它默认向已存在的注释中添加一个新的项。Group