refactor api documentation structure
This commit is contained in:
45
docs/api/XCEngine/Threading/TaskSystem/Submit.md
Normal file
45
docs/api/XCEngine/Threading/TaskSystem/Submit.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# TaskSystem::Submit
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
该方法在 `XCEngine/Threading/TaskSystem.h` 中提供了 2 个重载,当前页面统一汇总这些公开声明。
|
||||
|
||||
## 重载 1: 声明
|
||||
|
||||
```cpp
|
||||
uint64_t Submit(std::unique_ptr<ITask> task);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `task` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `uint64_t` - 返回值语义详见头文件声明。
|
||||
|
||||
## 重载 2: 声明
|
||||
|
||||
```cpp
|
||||
uint64_t Submit(std::function<void()>&& func, TaskPriority priority = TaskPriority::Normal);
|
||||
```
|
||||
|
||||
**参数:**
|
||||
- `func` - 参数语义详见头文件声明。
|
||||
- `priority` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `uint64_t` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskSystem object;
|
||||
// 根据上下文补齐参数后调用 TaskSystem::Submit(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
Reference in New Issue
Block a user