Skip to content

Commit 69d52d5

Browse files
nevstopnevstop
authored andcommitted
Merge branch 'copilot/add-csm-module-api-documentation' of https://github.com/NEVSTOP-LAB/CSMStand-Lite into copilot/add-csm-module-api-documentation
2 parents 2cdce45 + c6db667 commit 69d52d5

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

docs/App.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@
9090
| `MassData` | 内存映射缓冲区,传递 `Start:N,Size:M`,需要 CSM MassData Parameter Support 插件 |
9191
| 用户自定义 | 由模块自行解析的字符串,无需额外插件,但是要说明具体的解析规则和格式 |
9292

93+
> **注意**:接口文档中对 `String` 类型数据统一使用 `APIString` 标注(不直接写 `SafeStr`),因为 `SafeStr` 正是 `APIString` 针对 `String` 类型的内部实现。
94+
9395
---
9496

9597
## 内部操作接口
@@ -124,6 +126,7 @@
124126
## 调用限制与注意事项
125127

126128
> [!IMPORTANT]
129+
>
127130
> - 本模块为**单例**——同一时间不可运行多个实例。
128131
> - 本模块在 `Macro: Initialize` 阶段会自动启动内部的 `Engine(CSM)``ExecutionView(CSM)` 子模块,无需外部手动启动这两个模块。
129132
> - `API: Load Script File``API: Unload Sequence File` 为互斥操作,应避免并发调用。

docs/Engine(CSM).md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@
7474
| `MassData` | 内存映射缓冲区,传递 `Start:N,Size:M`,需要 CSM MassData Parameter Support 插件 |
7575
| 用户自定义 | 由模块自行解析的字符串,无需额外插件,但是要说明具体的解析规则和格式 |
7676

77+
> **注意**:接口文档中对 `String` 类型数据统一使用 `APIString` 标注(不直接写 `SafeStr`),因为 `SafeStr` 正是 `APIString` 针对 `String` 类型的内部实现。
78+
7779
---
7880

7981
## 状态广播接口
@@ -147,6 +149,7 @@
147149
## 调用限制与注意事项
148150

149151
> [!IMPORTANT]
152+
>
150153
> - 必须先调用 `TS: Load Sequence` 成功加载脚本后,才能调用 `TS: SinglePass`
151154
> - 使用 `TS: Terminate` 可以在执行过程中强制终止序列,但不会等待当前正在执行的 CSM 消息返回。
152155

docs/ExecutionView(CSM).md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@
7373
| `MassData` | 内存映射缓冲区,传递 `Start:N,Size:M`,需要 CSM MassData Parameter Support 插件 |
7474
| 用户自定义 | 由模块自行解析的字符串,无需额外插件,但是要说明具体的解析规则和格式 |
7575

76+
> **注意**:接口文档中对 `String` 类型数据统一使用 `APIString` 标注(不直接写 `SafeStr`),因为 `SafeStr` 正是 `APIString` 针对 `String` 类型的内部实现。
77+
7678
---
7779

7880
## 内部处理接口

0 commit comments

Comments
 (0)