提交 24f697df 编写于 作者: W wusongqing

fixed 2a38cda1 from https://gitee.com/wusongqing/docs/pulls/4111

Added api change template
Signed-off-by: Nwusongqing <wusongqing@huawei.com>
上级 959449dc
# ChangeLog
## *Example* Subsystem (Do not modify or delete this example)
Changes that affect contract compatibility of a released version should be described in the ChangeLog. The changes include but are not limited to those related to API names, parameters, return values, required permissions, call sequence, enumerated values, configuration parameters, and paths. Contract compatibility, also called semantic compatibility, means that the original program behavior should remain consistent over versions.
### cl.subsystemname.x xxx Function Change (Example: DeviceType Attribute Change or Camera Permission Change. Use a short description.)
Add the number **cl.*subsystemname*.*x*** before each change title, where **cl** is the abbreviation of ChangeLog, *subsystemname* is the standard English name of the subsystem, and *x* indicates the change sequence number (in ascending order).
Describe the changes in terms of functions. Example: *n* and *m* of the *a* function are changed. Developers need to adapt their applications based on the change description.
If there is a requirement or design document corresponding to the change, attach the requirement number or design document number in the description.
**Change Impact**
Describe whether released APIs (JS, Java, or native APIs) are affected or API behavior is changed.
**Key API/Component Changes**
List the API/component changes involved in the function change.
**Adaptation Guide (Optional)**
Provide guidance for developers on how to adapt their application to the changes to be compatible with the new version. Example:
Change parameter *n* to *m* in the *a* file.
```
sample code
```
### cl.subsystemname.x xxx Function Change
If a subsystem introduces any function changes, include a standalone section in the subsystem chapter to describe the function changes.
## *Example* Subsystem
Each subsystem has only one such chapter.
# JS API Diff
## Component
| Component Type | Component Name | Change Type | Change Description |
| -------- | -------- | -------- | -------- |
| Describe the component type, for example, container component, basic component, and media component. | Describe the component name, for example, **div** and **button**. | Describe the change type, which can be **Added**, **Deleted**, **Deprecated**, or **Modified**. | If the change type is **Deprecated**, describe the substitute. If the change type is **Modified**, describe the changes. For example, "Added the parameter *x*"; "Changed the default value of parameter *x* from *y* to *z*". If the change type is **Added** or **Deleted**, use the hyphen (-) here. |
## API Changes
| Module | API | Change Type | Change Description |
| -------- | -------- | -------- | -------- |
| Describe the module to which the API belongs, for example, data storage and file storage. | Describe the API name, for example, **storage.get(OBJECT)**. If the entire module is added, you can use the hyphen (-) here. | Describe the change type, which can be **Added**, **Deleted**, **Deprecated**, or **Modified**. | If the change type is **Deprecated**, describe the substitute. If the change type is **Modified**, describe the changes. For example, "Added the parameter *x*"; "Changed the default value of parameter *x* from *y* to *z*". If the change type is **Added** or **Deleted**, use the hyphen (-) here. |
# Native API Diff
| Module | API | Change Type | Change Type |
| -------- | -------- | -------- | -------- |
| List the module name, for example, **Native_layer**, **Image**, and **Media**. | Describe the name of the changed element, including the structure, type definition, enumeration, and function, for example, struct **NativeLayerBuffer**, type definition **NativeLayer**, and function **GetNativeLayer (JNIEnv *env, jobject surface)**. If the entire module is added, you can use the hyphen (-) here. | Describe the change type, which can be **Added**, **Deleted**, **Deprecated**, or **Modified**. | If the change type is **Deprecated**, describe the substitute. If the change type is **Modified**, describe the changes. For example, "Added the parameter *x*"; "Changed the default value of parameter *x* from *y* to *z*". If the change type is **Added** or **Deleted**, use the hyphen (-) here. |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册