DoxyGen文档之七

本文详细介绍了Doxygen中的两种归组机制:Modules模块和Member Groups。Modules用于在独立页面上组织file, namespace, classes等,通过/groupdef命令定义并使用/ingroup将成员归组。Member Groups则用于在类或文件中按语义归组成员,可通过//@{...//@}或/*@{.../*@}}定义,并使用@name指定组头。" 51180335,2125933,C++ cin 输入流的三种读取方法详解,"['C++', '输入输出']
摘要由CSDN通过智能技术生成

第四章:Grouping归组

Doxygen有两种机制进行归组。第一种是全局级,为每个group创建一个新的page。这些groups在注释中被称作“modules”。另一种机制使用于一些compound entity中的member list,称为“member group”。

Modules模块

Modules是一种归组things在分离的page上的方式。组的成员可以是filenamespaceclassesfunctionsvariablesenumstypedefsdefines,但也可以是其他groups

 

要定义一个group,应该在一个特殊注释块放置/defgroup。命令的第一个参数应该是唯一标志该group的标签。要将一个entity归为某个group的一个member,在entity前放置/ingroup命令。第二个参数是grouptitle

 

要避免在注释中每个member前放置/ingroup命令,可以将member@{ @}封装起来。@{@}标记可以放置group的注释中,也可以在一个独立的注释块

使用这些group的标记符号groups也可以嵌套。

 

如果多次使用一个group标签,将会出错。如果不希望doxygen强行执行唯一标签,可以使用/addtogroup而非/defgroup。运作方式和/defgroup很像,但是如果该group已经定义,它默认向已存在的注释中添加一个新的项。Group

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值