docs: fix threading module documentation discrepancies
- Fix include paths: use #include "Threading/..." instead of <XCEngine/Threading/...> - Document protected ITask constructors (ITask(), ITask(TaskPriority)) - Document Callback typedef in TaskGroup - Clarify Mutex STL-compatible methods are const - Note GetProgress() implementation limitation (returns 0.0f)
This commit is contained in:
@@ -22,7 +22,7 @@
|
||||
|
||||
## STL 兼容方法
|
||||
|
||||
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念(**注意**:这些方法为 const 成员函数)。
|
||||
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念。**注意**:这些方法为 `const` 成员函数。
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ float GetProgress() const
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:** 当前实现中 `m_completedCount` 未被更新,此方法始终返回 0.0f(任务组为空时返回 1.0f)。此为实现限制。
|
||||
**注意:** 当前实现中 `m_completedCount` 未被更新,此方法始终返回 0.0f(任务组为空时返回 1.0f)。此为实现限制,文档仅作记录。
|
||||
|
||||
**示例:**
|
||||
|
||||
|
||||
@@ -12,6 +12,12 @@
|
||||
|
||||
`TaskGroup` 提供了一种批量管理任务的机制。它允许添加多个任务、设置任务依赖关系、等待所有任务完成,并提供进度回调功能。
|
||||
|
||||
## 公共类型
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `Callback = std::function<void()>` | 任务组回调函数类型 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 构造/析构
|
||||
|
||||
@@ -43,6 +43,8 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `ITask()` | 默认构造函数(受保护) |
|
||||
| `ITask(TaskPriority priority)` | 带优先级的构造函数(受保护) |
|
||||
| [`Execute`](execute.md) | 任务执行逻辑(纯虚) |
|
||||
| [`OnComplete`](oncomplete.md) | 任务完成回调(可重写) |
|
||||
| [`OnCancel`](oncancel.md) | 任务取消回调(可重写) |
|
||||
|
||||
@@ -20,7 +20,7 @@ void Start(Func&& func, const Containers::String& name = "Thread")
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/Thread.h>
|
||||
#include "Threading/Thread.h"
|
||||
|
||||
Thread worker;
|
||||
worker.Start([]() {
|
||||
|
||||
@@ -53,7 +53,7 @@
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/Thread.h>
|
||||
#include "Threading/Thread.h"
|
||||
|
||||
// 创建并启动线程
|
||||
Thread thread;
|
||||
|
||||
@@ -47,7 +47,7 @@ Threading 模块提供了一套完整的多线程编程工具,包括线程封
|
||||
## 任务系统使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
#include "Threading/TaskSystem.h"
|
||||
|
||||
// 初始化任务系统
|
||||
TaskSystemConfig config;
|
||||
|
||||
Reference in New Issue
Block a user