阅读Sofia-SIP源码五 源码文件文档化的注释

本文通过分析Sofia-SIP的sofia-sip/su_types.h头文件,揭示了如何使用Doxygen在源码中编写注释以生成文档。重点介绍了@since和@sa这两个关键字,前者用于标记自哪个版本开始引入,后者用于指示相关内容参考。注释必须紧邻typedef,并以/**开头,以实现有效的文档展示。
摘要由CSDN通过智能技术生成

偶然看到Sofia wiki中某一个头文件的文档页面时,突然觉得像是明白了如何在头文件中写那些Doxygen可以使用的注释内容了。就以sofia-sip/su_types.h头文件为例说明。



#ifndef SU_TYPES_H
/** Defined when <sofia-sip/su_types.h> has been included */
#define SU_TYPES_H
上面那张图对应的是上面这段代码。这是介绍头文件卫哨宏。显然文字内容取自注释文字。


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值