refactor api documentation structure

This commit is contained in:
2026-03-26 16:45:24 +08:00
parent 45842e961e
commit 6244b586bb
4389 changed files with 80504 additions and 69241 deletions

View File

@@ -0,0 +1,30 @@
# TaskSystem::CreateTaskGroup
创建新对象或资源。
```cpp
TaskGroup* CreateTaskGroup();
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `TaskGroup*` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::CreateTaskGroup(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,31 @@
# TaskSystem::DestroyTaskGroup
公开方法,详见头文件声明。
```cpp
void DestroyTaskGroup(TaskGroup* group);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:**
- `group` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::DestroyTaskGroup(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,29 @@
# TaskSystem::Get
获取相关状态或对象。
```cpp
static TaskSystem& Get();
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `TaskSystem&` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
auto& instance = XCEngine::Threading::TaskSystem::Get();
(void)instance;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,30 @@
# TaskSystem::GetWorkerThreadCount
获取相关状态或对象。
```cpp
uint32_t GetWorkerThreadCount() const;
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `uint32_t` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::GetWorkerThreadCount(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,31 @@
# TaskSystem::Initialize
初始化内部状态。
```cpp
void Initialize(const TaskSystemConfig& config);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:**
- `config` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::Initialize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,33 @@
# TaskSystem::ParallelFor
公开方法,详见头文件声明。
```cpp
template<typename Func> void ParallelFor(int32_t start, int32_t end, Func&& func);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:**
- `start` - 参数语义详见头文件声明。
- `end` - 参数语义详见头文件声明。
- `func` - 参数语义详见头文件声明。
**返回:** `template<typename Func> void` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::ParallelFor(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,31 @@
# TaskSystem::RunOnMainThread
公开方法,详见头文件声明。
```cpp
void RunOnMainThread(std::function<void()>&& func);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:**
- `func` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::RunOnMainThread(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,30 @@
# TaskSystem::Shutdown
关闭并清理内部状态。
```cpp
void Shutdown();
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::Shutdown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View 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)

View File

@@ -0,0 +1,40 @@
# TaskSystem
**命名空间**: `XCEngine::Threading`
**类型**: `class (singleton)`
**头文件**: `XCEngine/Threading/TaskSystem.h`
**描述**: 定义 `XCEngine/Threading` 子目录中的 `TaskSystem` public API。
## 概述
`TaskSystem.h``XCEngine/Threading` 子目录 下的 public header当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `TaskSystem` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [Get](Get.md) | 获取相关状态或对象。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [Submit](Submit.md) | 公开方法,详见头文件声明。 |
| [CreateTaskGroup](CreateTaskGroup.md) | 创建新对象或资源。 |
| [DestroyTaskGroup](DestroyTaskGroup.md) | 公开方法,详见头文件声明。 |
| [Wait](Wait.md) | 公开方法,详见头文件声明。 |
| [GetWorkerThreadCount](GetWorkerThreadCount.md) | 获取相关状态或对象。 |
| [Update](Update.md) | 更新运行时状态。 |
| [ParallelFor](ParallelFor.md) | 公开方法,详见头文件声明。 |
| [RunOnMainThread](RunOnMainThread.md) | 公开方法,详见头文件声明。 |
## 相关文档
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

View File

@@ -0,0 +1,30 @@
# TaskSystem::Update
更新运行时状态。
```cpp
void Update();
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::Update(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,31 @@
# TaskSystem::Wait
公开方法,详见头文件声明。
```cpp
void Wait(uint64_t taskId);
```
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
**参数:**
- `taskId` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/TaskSystem.h>
void Example() {
XCEngine::Threading::TaskSystem object;
// 根据上下文补齐参数后调用 TaskSystem::Wait(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](TaskSystem.md)
- [返回模块目录](../Threading.md)