mirror of
https://github.com/openharmony/interface_sdk_c.git
synced 2026-08-24 06:23:09 -04:00
openharmony_ci
04814acf2c
公共事件C接口描述回刷（对照docs仓MR同步中英文） Created-by: wangsen1994 Commit-by: wangsen1994 Merged-by: openharmony_ci Description: ### 相关的Issue #4429 ### 原因（目的、解决的问题等） docs 仓公共事件相关中文资料已修改（MR !153287/!156408）并完成英文翻译（MR !154911/!157063），需将对应中英文描述回刷到 SDK C 接口代码，使 SDK 接口描述与 docs 仓最新资料保持一致。 ### 描述（做了什么，变更了什么） 对照 docs 仓上述 MR 的资料变更，将公共事件 C 接口 oh_commonevent.h（中英文各一份，共 2 个文件）的 Doxygen 注释描述回刷为与 docs 最新内容一致： - 仅修改 @brief 描述/结构体字段描述/枚举成员描述/@param与@return描述等描述文本 - 不改动 @since/@version/@library/@kit/@syscap/@addtogroup/@file 等标签 - 不改动 C 函数/结构体/枚举成员/typedef 等声明与文件结构，版权头/#ifndef 保持不变 另：移除 OH_CommonEvent_Publish 函数 @return 注释中新增错误码 COMMONEVENT_ERR_NOT_SYSTEM_SERVICE 的返回说明（中英文各一处），属非兼容变更。 涉及文件： - BasicServicesKit/commonevent/oh_commonevent.h - zh-cn/BasicServicesKit/commonevent/oh_commonevent.h ### 自检结果（结果截图添加到下面） - [x] 是否通过C语法扫描 - [x] 是否通过注释规则扫描 - [x] 是否更新json文件 - [x] 实现代码是否已经合入 - [x] 目标是否已经添加到interface/sdk_c仓ndk依赖目标(ndk_targets.gni)里 - [x] 头文件library声明与SDK so库名称一致 ### 兼容性影响评估，如有影响请写明（Y/N） - [x] Y 不兼容（OH_CommonEvent_Publish @return 返回错误码列表移除 COMMONEVENT_ERR_NOT_SYSTEM_SERVICE 说明，文档化契约变更） - [ ] 是否经过评审 ### L0新增用例自检结果 - [ ] 是，有新增L0用例，且完成自检 - [x] 否 ### API参考文档影响评估（提供docs仓pr链接） - [x] 是，已刷新API参考文档 - https://gitcode.com/openharmony/docs/pull/153287 - https://gitcode.com/openharmony/docs/pull/156408 - https://gitcode.com/openharmony/docs/pull/154911 - https://gitcode.com/openharmony/docs/pull/157063 See merge request: openharmony/interface_sdk_c!5666