偶然看到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上面那张图对应的是上面这段代码。这是介绍头文件卫哨宏。显然文字内容取自注释文字。
本文通过分析Sofia-SIP的sofia-sip/su_types.h头文件,揭示了如何使用Doxygen在源码中编写注释以生成文档。重点介绍了@since和@sa这两个关键字,前者用于标记自哪个版本开始引入,后者用于指示相关内容参考。注释必须紧邻typedef,并以/**开头,以实现有效的文档展示。
偶然看到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上面那张图对应的是上面这段代码。这是介绍头文件卫哨宏。显然文字内容取自注释文字。
1510
1442

被折叠的 条评论
为什么被折叠?