未验证 提交 5a381350 编写于 作者: O openharmony_ci 提交者: Gitee

!14177 更新API模板

Merge pull request !14177 from zengyawen/master
......@@ -104,7 +104,7 @@ import call from '@ohos.telephony.call';
**系统能力:** SystemCapability.xxx.xxx。(必选)
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ---------------- | ----------------------------------------- | ---- | ---- | ------------------------------------------ |
| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 |
| isBatteryPresent | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
......@@ -306,10 +306,10 @@ import call from '@ohos.telephony.call';
**系统能力:** SystemCapability.xxx.xxx(必选)
| 名称 | 类型 | 必填 | 说明 |
| ------------ | ------------------- | ---- | ------------------------------------------------------------ |
| parameterUrl | string | 是 | 媒体输出URI。支持: <br/>1. 协议类型为“internal”的相对路径,示例如下: 临时目录:internal://cache/test.mp4 <br/>2. 文件的绝对路径,示例如下: file:///data/data/ohos.xxx.xxx/files/test.mp4 |
| parameterOne | [CustomEnum](#枚举) | 否 | 属性描述,要求与参数说明类似。 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ------------ | ------------------- | ------ | ----- | ------------------------------------------------------------ |
| parameterUrl | string | 否 | 是 | 媒体输出URI。支持: <br/>1. 协议类型为“internal”的相对路径,示例如下: 临时目录:internal://cache/test.mp4 <br/>2. 文件的绝对路径,示例如下: file:///data/data/ohos.xxx.xxx/files/test.mp4 |
| parameterOne | [CustomEnum](#枚举) | 否 | 否 | 属性描述,要求与参数说明类似。 |
## Type
......@@ -317,7 +317,7 @@ import call from '@ohos.telephony.call';
>
> 1. 可选,如果没有可删除此二级标题,对应d.ts中的type联合类型。
>
> 2. 默认第一列为“类型”。如果全部为具体字符串,可将第一列修改为“取值”
> 2. 如果为取值范围为具体取值,如固定的字符串、枚举值等,需要说明其数据类型和指定取值;如果取值范围为指定类型,需说明是否取类型下任意值,还是有取值范围
>
> 3. 类型如果为自定义类型,需要建立链接到对应的interface或enum中。
......@@ -325,14 +325,15 @@ import call from '@ohos.telephony.call';
**系统能力:** SystemCapability.xxx.xxx(必选)
| 类型 | 说明 |
| 取值范围 | 说明 |
| -----------| ---------------------------- |
| number | 表示值类型为数字 |
| string | 表示值类型为字符 |
| number | 表示值类型为数字,可取任意值。 |
| string | 表示值类型为字符,可取任意值。 |
## 变更日志
| 变更说明 | 日期 |
| ----------------------------------------------------------------------- | ------------ |
| 1. 修改属性的模板,将“可读”、“可写”、“必填”,统一为“只读”、“必填”。<br/>2. 修改Type的模板,模板修改为“取值范围/说明”,并增加相关说明。 | 2023/02/01 |
| 1. 总体写作说明整理为表格。<br/>2. “图片路径”中,增加图片的引用方式说明。<br/>3. 增加“文档结构”,对文档各节点顺序进行说明。<br/>4. “权限说明”中,增加多权限的描述方式。<br/>5. 增加@FAModelOnly/@StageModelOnly标记在文档的描述方式。<br/>6. 增加异步接口说明(callback、Promise)。<br/>7. 增加示例代码语言的标准和规范。<br/>8. 增加文档链接的标准写法。<br/>9. 增加模块描述的固定句式、示例。<br/>10. 增加“on/off”等订阅方法的说明。<br/>11. 修改@syscap的描述方式,除表格内的差异项,其余保持一致。 <br/>12. 修改@systemapi的描述方式,仅保留“该系统为系统接口。”。<br/>13. 删除MR版本说明。 | 2022/6/24 |
| 增加错误码说明。 | 2022/10/11 |
| 1. 增加**常量const****类型type**的模板。<br/> 2. 修改自定义类型interface的表格,去除“可读、可写”,与d.ts保持一致,增加“必填”。<br/> 3. 针对同时存在起始版本和废弃版本的接口,增加废弃说明的模板。 |2022/11/22 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册