docs: 修正 API 文档准确性 (第二轮检查)

修复的问题:
- math: 修复 Quaternion::Normalize 链接错误
- containers: HashMap 迭代器示例使用不存在的 cbegin/cend,删除冗余构造函数声明
- core: RefCounted 析构函数访问级别修正 (protected)
- debug: LogLevelToString 示例返回值大小写修正
- memory: 修正 LinearAllocator::Reallocate 返回 nullptr,ProxyAllocator 统计描述,头文件路径 IAllocator.h -> Allocator.h
- resources: Texture::Create mipLevels 参数描述修正
- rhi: 修复多处链接错误,新增缺失的方法文档
- threading: TaskSystem 配置项未实现状态标注,Wait 方法空实现标注
This commit is contained in:
2026-03-19 00:31:14 +08:00
parent dc850d7739
commit a9f882f233
54 changed files with 362 additions and 79 deletions

View File

@@ -22,9 +22,9 @@ void Initialize(const TaskSystemConfig& config)
```cpp
TaskSystemConfig config;
config.workerThreadCount = std::thread::hardware_concurrency();
config.enableTaskProfiling = true;
config.stealTasks = true;
config.maxTaskQueueSize = 2048;
config.enableTaskProfiling = true; // 预留配置项(当前未使用)
config.stealTasks = true; // 预留配置项(当前未实现)
config.maxTaskQueueSize = 2048; // 预留配置项(当前未强制限制)
TaskSystem::Get().Initialize(config);
printf("TaskSystem started with %u workers\n",

View File

@@ -6,11 +6,13 @@
**头文件**: `XCEngine/Threading/TaskSystem.h`
**描述**: 并行任务调度系统单例,提供工作窃取式任务队列和并行 for 循环
**描述**: 并行任务调度系统单例,提供优先级任务队列
## 概述
`TaskSystem` 是 XCEngine 的核心并行任务调度系统。它创建多个工作线程,使用优先级队列和工作窃取算法调度任务。它还提供 `ParallelFor` 方法用于数据级并行,以及主线程任务队列。
`TaskSystem` 是 XCEngine 的核心并行任务调度系统。它创建多个工作线程,使用优先级队列调度任务。它还提供 `ParallelFor` 方法用于数据级并行,以及主线程任务队列。
**注意:** 当前实现的 `stealTasks` 配置项未生效,任务系统使用单一全局任务队列而非工作窃取模式。
## 单例访问

View File

@@ -6,8 +6,6 @@ void Wait(uint64_t taskId)
**注意:** 此方法当前为空实现,不执行任何操作。
阻塞当前线程,等待指定任务完成(功能暂未实现)。
**参数:**
- `taskId` - 要等待的任务 ID
@@ -15,7 +13,9 @@ void Wait(uint64_t taskId)
**复杂度:** N/A空实现
**建议** 建议使用 `TaskGroup::Wait` 代替此方法
**当前状态** 此方法为空实现,不执行任何操作。任务系统目前不支持按任务 ID 等待
**建议:** 使用 `TaskGroup::Wait` 代替此方法。
**示例:**