Skip to content

Commit e5bfc58

Browse files
JackLianliujuping
JackLian
authored and
liujuping
committed
docs: optimize api doc for model/modal-node-manager, and fix related lint issues
1 parent 7d526d1 commit e5bfc58

32 files changed

+231
-171
lines changed

‎docs/docs/api/canvas.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ get dragon(): IPublicModelDragon | null;
4242
get activeTracker(): IPublicModelActiveTracker | null;
4343
```
4444

45-
## 方法签名
45+
## 方法
4646

4747
### createLocation
4848
创建一个文档插入位置对象，该对象用来描述一个即将插入的节点在文档中的位置

‎docs/docs/api/common.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ sidebar_position: 11
2020
#### skeletonCabin
2121
面板扩展相关，详见下方方法签名
2222

23-
## 方法签名
23+
## 方法
2424
### utils
2525
#### isNodeSchema
2626
是否为合法的 schema 结构

‎docs/docs/api/config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_position: 8
1010
## 模块简介
1111
配置模块，负责配置的读、写等操作。
1212

13-
## 方法签名
13+
## 方法
1414
### get
1515
获取指定 key 的值
1616

‎docs/docs/api/event.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_position: 7
1010
## 模块简介
1111
负责事件处理 API，支持自定义监听事件、触发事件。
1212

13-
## 方法签名
13+
## 方法
1414
### on
1515
监听事件
1616

‎docs/docs/api/hotkey.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 5
99
## 模块简介
1010
绑定快捷键 API，可以自定义项目快捷键使用。
1111

12-
## 方法签名
12+
## 方法
1313
### bind
1414
绑定快捷键
1515

‎docs/docs/api/init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 10
88

99
## 模块简介
1010
提供 init 等方法
11-
## 方法签名
11+
## 方法
1212
#### 1. init
1313
初始化引擎
1414

‎docs/docs/api/logger.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sidebar_position: 9
1212
> 注：日志级别可以通过 url query 动态调整，详见下方[查看示例](#查看示例)。<br/>
1313
> 参考 [zen-logger](https://web.npm.alibaba-inc.com/package/zen-logger) 实现进行封装
1414
15-
## 方法签名
15+
## 方法
1616

1717
日志记录方法
1818

‎docs/docs/api/material.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ get componentsMap(): { [key: string]: IPublicTypeNpmInfo | ComponentType<any> |
2222
```
2323
相关类型：[IPublicTypeNpmInfo](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/npm-info.ts)
2424

25-
## 方法签名
25+
## 方法
2626

2727
### 资产包
2828
#### setAssets

‎docs/docs/api/model/detecting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 6
99

1010
画布节点悬停模型
1111

12-
## 变量
12+
## 属性
1313

1414
### current
1515

@@ -28,7 +28,7 @@ sidebar_position: 6
2828
`@type {boolean}`
2929

3030

31-
## 方法签名
31+
## 方法
3232
### capture
3333

3434
hover 指定节点

‎docs/docs/api/model/document-model.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 0
99

1010
文档模型
1111

12-
## 变量
12+
## 属性
1313

1414
### id
1515

@@ -95,7 +95,7 @@ sidebar_position: 0
9595

9696
**@since v1.1.0**
9797

98-
## 方法签名
98+
## 方法
9999
### getNodeById
100100

101101
根据 nodeId 返回 [Node](./node) 实例

0 commit comments

Comments
 (0)