如何在Doxygen中将API标记为已删除(不使用deprecated)?
Doxygen 标记无实现API(已删除)的方案
1. 配置Doxyfile添加自定义标记别名
无需使用官方的deprecated标记,通过自定义别名即可实现专属的已删除API标识,打开项目的Doxy配置文件,找到ALIASES配置项,添加如下定义:
# 基础版:无额外说明的已删除标记 ALIASES += removed="\par \attention 已移除实现:\n该接口无对应实现,调用会触发链接错误" # 扩展版:支持传入删除版本、替代接口等说明 ALIASES += removed{1}="\par \attention 已移除实现:\n\1"
2. 在头文件API注释中使用标记
直接在需要标记的接口的Doxygen注释块内调用\removed命令即可,示例:
/** * @brief 旧版用户信息查询接口 * @param user_id 用户ID * @return 用户信息结构体指针 * \removed 自v2.4.0版本移除实现,请使用`query_user_info_v2()`替代 */ UserInfo* query_user_info(int user_id);
生成文档后,该接口的文档区会自动显示醒目的提示块,告知使用者该接口已无实现不可调用。
可选:生成已删除API汇总列表
如果需要将所有已删除的API统一汇总到单独页面,可改用\xrefitem定义别名:
ALIASES += removed{1}="\xrefitem removed \"已移除API\" \"已移除API汇总列表\" 移除说明:\1\n"
配置完成后Doxygen会自动生成独立的已移除API汇总页,所有标记了\removed的接口都会被收录到该页面。
内容的提问来源于stack exchange,提问作者ChrisZZ
相关产品推荐
相关产品推荐

