未验证 提交 6521bf98 编写于 作者: O openharmony_ci 提交者: Gitee

!14189 更新API模板

Merge pull request !14189 from zengyawen/master
......@@ -161,15 +161,15 @@ import call from '@ohos.telephony.call';
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| parameterOne | number \| string \| [CustomType](#customtype) | 是 | 参数描述。给出取值范围、建议值。如果有固定格式,需要给出格式样例,尤其是URI。<br/>自定义类型需要进行建链说明。 |
| callback | Callback\<Array<[CustomType](#customtype)>> | 否 | 参数描述。可选参数需要说明不填写该参数的后果。<br/>如:不填该参数则取消该type对应的所有回调。<br/>callback写法参考总体写作说明第14项。 |
| parameterOne | number \| string \| [CustomType](#classinterface) | 是 | 参数描述。给出取值范围、建议值。如果有固定格式,需要给出格式样例,尤其是URI。<br/>自定义类型需要进行建链说明。 |
| callback | Callback\<Array<[CustomType](#classinterface)>> | 否 | 参数描述。可选参数需要说明不填写该参数的后果。<br/>如:不填该参数则取消该type对应的所有回调。<br/>callback写法参考总体写作说明第14项。 |
**返回值**:(可选,如不涉及可删除)
| 类型 | 说明 |
| ------------------------------------------ | ----------------------------------------------- |
| string | 返回值描述。取到返回值之后,可以用来做什么。 |
| Promise\<Array<[CustomType](#CustomType)>> | 返回值描述。Promise写法参考总体写作说明第14项。 |
| Promise\<Array<[CustomType](#classinterface)>> | 返回值描述。Promise写法参考总体写作说明第14项。 |
**错误码**:(可选,如不涉及可删除)
......@@ -227,7 +227,7 @@ import call from '@ohos.telephony.call';
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件描述,需要说明触发时机。如一个方法涉及多个事件,需要分开说明。<br/>**示例1(单个):**<br/>事件回调类型,支持的事件为`'play'`,当`play()`调用完成,音频开始播放,触发该事件。<br/>**示例2(多个):**<br/>事件回调类型,支持的事件包括:`'play'` \| `'dataLoad' `\|`'finish'`<br/>\- `'play'`:完成`play()`调用,音频开始播放,触发该事件。<br/>\- `'dataLoad'`:完成音频数据加载后触发该事件,即src属性设置完成后触发该事件。<br/>\- `'finish'`:完成音频播放后触发该事件。 |
| callback | Callback\<[CustomType](#CustomType)> | 否 | 参数描述。与[方法](#方法)要求一致。 |
| callback | Callback\<[CustomType](#classinterface)> | 否 | 参数描述。与[方法](#方法)要求一致。 |
**返回值:**(可选,如不涉及可删除)
......@@ -261,7 +261,7 @@ import call from '@ohos.telephony.call';
> 2. 二级标题名为class、interface的名称。
>
> 3. 如果该API中,既有属性,又有方法,需要先进行属性的写作,并使用“###”三级标题。
> 如果该API中,只有属性,那么不需要新建三级标题,直接使用表格陈列属性,具体示例参考[CustomType](#CustomType)
> 如果该API中,只有属性,那么不需要新建三级标题,直接使用表格陈列属性。
类描述/interface描述。如果有使用限制,需要在这个地方说明。比方说,是否有前提条件,是否需要通过什么方法先构造一个实例。
......@@ -269,7 +269,7 @@ import call from '@ohos.telephony.call';
> *写作说明*
>
> 除标题使用三级标题外,其余要求同[属性](#属性)。
> 除标题使用三级标题外,其余要求同[属性](#属性),如仅有属性,可删除
### Class/Interface中的方法
......@@ -296,21 +296,6 @@ import call from '@ohos.telephony.call';
| ---- | ---- | -------------------------- |
| NONE | 1 | 表示连接的充电器类型未知。 |
## CustomType
> *写作说明*
>
> 可选,如果没有可删除此二级标题,对应d.ts中无方法的Interface。
仅有k-v键值对的自定义类型示例。
**系统能力:** 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](#枚举) | 否 | 否 | 属性描述,要求与参数说明类似。 |
## Type
> *写作说明*
......@@ -333,7 +318,7 @@ import call from '@ohos.telephony.call';
## 变更日志
| 变更说明 | 日期 |
| ----------------------------------------------------------------------- | ------------ |
| 1. 修改属性的模板,将“可读”、“可写”、“必填”,统一为“只读”、“必填”。<br/>2. 修改Type的模板,模板修改为“取值范围/说明”,并增加相关说明。 | 2023/02/01 |
| 1. 修改属性的模板,将“可读”、“可写”、“必填”,统一为“只读”、“必填”。<br/>2. 修改Type的模板,模板修改为“取值范围/说明”,并增加相关说明。<br/>3. 删除自定义类型,合并进class和interface的模板中。 | 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.
先完成此消息的编辑!
想要评论请 注册