登录
注册
开源
企业版
高校版
搜索
帮助中心
使用条款
关于我们
开源
企业版
高校版
私有云
模力方舟
登录
注册
代码拉取完成，页面将自动刷新
仓库状态说明
捐赠
捐赠前请先登录
取消
前往登录
扫描微信二维码支付
取消
支付完成
支付提示
将跳转至支付宝完成支付
确定
取消
Watch
不关注
关注所有动态
仅关注版本发行动态
关注但不提醒动态
27
Star
17
Fork
796
OpenHarmony-SIG
/
interface_native_header
关闭
代码
Issues
117
Pull Requests
33
Wiki
统计
流水线
服务
JavaDoc
PHPDoc
质量分析
Jenkins for Gitee
腾讯云托管
腾讯云 Serverless
悬镜安全
阿里云 SAE
Codeblitz
SBOM
我知道了，不再自动展开
更新失败，请稍后重试！
移除标识
内容风险标识
本任务被
标识为内容中包含有代码安全 Bug 、隐私泄露等敏感信息，仓库外成员不可访问
USB模块（usbd_client.h）HDI评审意见
待办的
#I5AWP5
缺陷
liyan
创建于
2022-06-06 17:09
【公共】 1、group和file的brief中，都描述过于简单，没有明确写出使用场景或使用建议。 2、所有注释中描述性的“usb”字样，请统一使用大写。 3、没有看到使用@see 关联的函数。请确认，是不是确实不存在。 4、所有brief、param、return的描述后请补充句号，特别是句子中已经有逗号的。 【usbd_client.h】 1、namespace OHOS、namespace USB、class UsbdClient、 static UsbdClient &GetInstance() 没有注释。 2、返回值除定值外，另外一个采用统一的描述“其他值”。 * @return 0 表示操作成功 * @return 非零值 表示操作失败 3、上下文描述不一致  4、基本上所有接口都没有写使用场景，不明确什么时候需要调用相关接口，获取到的输出参数，可以用来干什么。 5、作为输入参数的几个id，没有取值范围，也没有参考信息。 6、SetConfig和GetConfig中，对于config信息没有任何介绍。 7、ClaimInterface中force的含义没说清楚。 8、@param altIndex 输入参数，interface的AlternateSetting信息-- 这是什么信息？没有说清楚。 9、param timeout 输入参数，超时时间-- 没有取值范围，也没有单位说明。 10、ControlTransfer的brief看不懂。 11、IsoTransferRead中，可否介绍一下“等时数据读取/写入”的概念？ 12、@brief 将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定--- 什么意思？ 13、RequestQueue中后两个输入参数，不明白有什么分别。 14、SetCurrentFunctions 从设备的funcs，可以参考哪里？文中没有对应介绍。 15、SetPortRole、QueryPortRole输入输出参数的解释不清晰，没有取值范围。
【公共】 1、group和file的brief中，都描述过于简单，没有明确写出使用场景或使用建议。 2、所有注释中描述性的“usb”字样，请统一使用大写。 3、没有看到使用@see 关联的函数。请确认，是不是确实不存在。 4、所有brief、param、return的描述后请补充句号，特别是句子中已经有逗号的。 【usbd_client.h】 1、namespace OHOS、namespace USB、class UsbdClient、 static UsbdClient &GetInstance() 没有注释。 2、返回值除定值外，另外一个采用统一的描述“其他值”。 * @return 0 表示操作成功 * @return 非零值 表示操作失败 3、上下文描述不一致  4、基本上所有接口都没有写使用场景，不明确什么时候需要调用相关接口，获取到的输出参数，可以用来干什么。 5、作为输入参数的几个id，没有取值范围，也没有参考信息。 6、SetConfig和GetConfig中，对于config信息没有任何介绍。 7、ClaimInterface中force的含义没说清楚。 8、@param altIndex 输入参数，interface的AlternateSetting信息-- 这是什么信息？没有说清楚。 9、param timeout 输入参数，超时时间-- 没有取值范围，也没有单位说明。 10、ControlTransfer的brief看不懂。 11、IsoTransferRead中，可否介绍一下“等时数据读取/写入”的概念？ 12、@brief 将指定的端点进行异步数据发送或者接收请求，数据传输方向由端点方向决定--- 什么意思？ 13、RequestQueue中后两个输入参数，不明白有什么分别。 14、SetCurrentFunctions 从设备的funcs，可以参考哪里？文中没有对应介绍。 15、SetPortRole、QueryPortRole输入输出参数的解释不清晰，没有取值范围。
评论 (
0
)
登录
后才可以发表评论
状态
待办的
待办的
已确认
技术评审中
修复中
验收中
已完成
已取消
已拒绝
挂起
负责人
未设置
标签
未设置
项目
未立项任务
未立项任务
里程碑
未关联里程碑
未关联里程碑
Pull Requests
未关联
未关联
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
未关联
未关联
master
PR_rdb
PR257
PR257B
PR_rdb_new
开始日期 - 截止日期
-
置顶选项
不置顶
置顶等级：高
置顶等级：中
置顶等级：低
优先级
不指定
严重
主要
次要
不重要
预计工期
（小时）
参与者（1）
1
https://gitee.com/openharmony-sig/interface_native_header.git
git@gitee.com:openharmony-sig/interface_native_header.git
openharmony-sig
interface_native_header
interface_native_header
点此查找更多帮助
搜索帮助
Git 命令在线学习
如何在 Gitee 导入 GitHub 仓库
Git 仓库基础操作
企业版和社区版功能对比
SSH 公钥设置
如何处理代码冲突
仓库体积过大，如何减小？
如何找回被删除的仓库数据
Gitee 产品配额说明
GitHub仓库快速导入Gitee及同步更新
什么是 Release（发行版）
将 PHP 项目自动发布到 packagist.org
评论
仓库举报
回到顶部
登录提示
该操作需登录 Gitee 帐号，请先登录后再操作。
立即登录
没有帐号，去注册
