docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
38
docs/api/threading/thread/detach.md
Normal file
38
docs/api/threading/thread/detach.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Thread::Detach
|
||||
|
||||
```cpp
|
||||
void Detach()
|
||||
```
|
||||
|
||||
分离线程,使其成为后台线程独立运行。分离后,线程的资源将在其终止时自动释放,调用线程不会被阻塞。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:**
|
||||
- 分离后的线程无法再被 Join 或进行任何同步操作。
|
||||
- 确保分离线程的所有资源访问都是线程安全的,因为主线程可能在分离线程结束前退出。
|
||||
- 如果 Thread 对象在分离线程结束前被销毁,行为取决于具体实现。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Thread background;
|
||||
background.Start([]() {
|
||||
printf("Background task running\n");
|
||||
for (int i = 0; i < 3; ++i) {
|
||||
Thread::Sleep(500);
|
||||
printf("Background: tick %d\n", i);
|
||||
}
|
||||
}, "BackgroundThread");
|
||||
|
||||
background.Detach();
|
||||
printf("Main thread continues immediately\n");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
30
docs/api/threading/thread/getcurrentid.md
Normal file
30
docs/api/threading/thread/getcurrentid.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Thread::GetCurrentId
|
||||
|
||||
```cpp
|
||||
static Id GetCurrentId()
|
||||
```
|
||||
|
||||
获取当前执行线程的唯一标识符。这是一个静态方法,可以在任何线程上下文中调用。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** `Thread::Id` - 当前执行线程的唯一标识符
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Thread worker;
|
||||
worker.Start([]() {
|
||||
printf("Worker thread id: %llu\n", (unsigned long long)Thread::GetCurrentId());
|
||||
}, "WorkerThread");
|
||||
|
||||
printf("Main thread id: %llu\n", (unsigned long long)Thread::GetCurrentId());
|
||||
worker.Join();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
- [GetId](getid.md) - 获取 Thread 对象的 ID
|
||||
30
docs/api/threading/thread/getid.md
Normal file
30
docs/api/threading/thread/getid.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Thread::GetId
|
||||
|
||||
```cpp
|
||||
Id GetId() const
|
||||
```
|
||||
|
||||
获取当前线程对象的唯一标识符。该 ID 在线程启动后有效。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** `Thread::Id` - 线程的唯一标识符(uint64_t 类型)
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:** 在调用 Start 之前返回 0。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Thread worker;
|
||||
printf("Before start: id=%llu\n", (unsigned long long)worker.GetId());
|
||||
worker.Start([]() {}, "Test");
|
||||
printf("After start: id=%llu\n", (unsigned long long)worker.GetId());
|
||||
worker.Join();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
- [GetCurrentId](getcurrentid.md) - 获取当前执行线程的 ID
|
||||
28
docs/api/threading/thread/getname.md
Normal file
28
docs/api/threading/thread/getname.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Thread::GetName
|
||||
|
||||
```cpp
|
||||
const Containers::String& GetName() const
|
||||
```
|
||||
|
||||
获取线程的名称。该名称在调用 Start 时设置。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** `const Containers::String&` - 线程名称的引用
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**注意:** 在调用 Start 之前返回空字符串。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Thread worker;
|
||||
worker.Start([]() {}, "ComputeThread");
|
||||
printf("Thread name: %s\n", worker.GetName().CStr());
|
||||
worker.Join();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
37
docs/api/threading/thread/join.md
Normal file
37
docs/api/threading/thread/join.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Thread::Join
|
||||
|
||||
```cpp
|
||||
void Join()
|
||||
```
|
||||
|
||||
等待线程结束并回收其资源。调用线程将被阻塞,直到目标线程完成执行。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(n),n 为目标线程的执行时间
|
||||
|
||||
**注意:**
|
||||
- 如果线程已经被分离(Detach)或已经 Join 过,调用此方法将导致未定义行为。
|
||||
- 建议在使用完 Thread 对象后始终调用 Join 或 Detach。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Thread worker;
|
||||
worker.Start([]() {
|
||||
for (int i = 0; i < 5; ++i) {
|
||||
printf("Working...\n");
|
||||
Thread::Sleep(100);
|
||||
}
|
||||
}, "WorkerThread");
|
||||
|
||||
printf("Main thread waiting...\n");
|
||||
worker.Join();
|
||||
printf("Worker thread finished\n");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
30
docs/api/threading/thread/sleep.md
Normal file
30
docs/api/threading/thread/sleep.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Thread::Sleep
|
||||
|
||||
```cpp
|
||||
static void Sleep(uint32_t milliseconds)
|
||||
```
|
||||
|
||||
使当前线程休眠指定的时间。线程在休眠期间不会消耗 CPU 时间。
|
||||
|
||||
**参数:**
|
||||
- `milliseconds` - 休眠时间,以毫秒为单位
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** 取决于操作系统的调度精度,通常为 O(milliseconds)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
printf("Start\n");
|
||||
Thread::Sleep(1000); // 休眠1秒
|
||||
printf("After 1 second\n");
|
||||
|
||||
Thread::Sleep(500); // 再休眠0.5秒
|
||||
printf("After 0.5 more seconds\n");
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
- [Yield](yield.md) - 让出时间片
|
||||
37
docs/api/threading/thread/start.md
Normal file
37
docs/api/threading/thread/start.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Thread::Start
|
||||
|
||||
```cpp
|
||||
template<typename Func>
|
||||
void Start(Func&& func, const Containers::String& name = "Thread")
|
||||
```
|
||||
|
||||
启动线程,执行传入的可调用对象。该方法创建一个新的执行线程,立即开始运行。
|
||||
|
||||
**参数:**
|
||||
- `func` - 要在线程中执行的可调用对象(lambda、函数指针、仿函数等)
|
||||
- `name` - 线程名称,用于调试和日志输出,默认值为 "Thread"
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**线程安全:** 该方法不是线程安全的,不应在同一 Thread 对象上并发调用。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/Thread.h>
|
||||
|
||||
Thread worker;
|
||||
worker.Start([]() {
|
||||
printf("Worker thread running\n");
|
||||
Thread::Sleep(100);
|
||||
printf("Worker thread done\n");
|
||||
}, "WorkerThread");
|
||||
|
||||
worker.Join();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
77
docs/api/threading/thread/thread.md
Normal file
77
docs/api/threading/thread/thread.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Thread
|
||||
|
||||
**命名空间**: `XCEngine::Threading`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Threading/Thread.h`
|
||||
|
||||
**描述**: 线程封装类,提供跨平台线程创建和管理功能。
|
||||
|
||||
## 概述
|
||||
|
||||
`Thread` 类封装了 `std::thread`,提供统一的线程管理接口,包括启动、加入、分离等操作。
|
||||
|
||||
## 公共类型
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `using Id = uint64_t` | 线程唯一标识符类型 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 生命周期
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `Thread()` | 默认构造函数 |
|
||||
| `~Thread()` | 析构函数 |
|
||||
|
||||
### 线程控制
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Start`](start.md) | 启动线程,执行传入的函数 |
|
||||
| [`Join`](join.md) | 等待线程结束 |
|
||||
| [`Detach`](detach.md) | 分离线程,使其独立运行 |
|
||||
|
||||
### 属性访问
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`GetId`](getid.md) | 获取线程 ID |
|
||||
| [`GetName`](getname.md) | 获取线程名称 |
|
||||
|
||||
### 静态方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`GetCurrentId`](getcurrentid.md) | 获取当前线程 ID |
|
||||
| [`Sleep`](sleep.md) | 线程休眠指定毫秒数 |
|
||||
| [`Yield`](yield.md) | 让出当前线程的时间片 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/Thread.h>
|
||||
|
||||
// 创建并启动线程
|
||||
Thread thread;
|
||||
thread.Start([]() {
|
||||
printf("Worker thread running\n");
|
||||
}, "WorkerThread");
|
||||
|
||||
// 等待线程结束
|
||||
thread.Join();
|
||||
|
||||
// 使用静态方法
|
||||
Thread::Sleep(1000); // 休眠1秒
|
||||
Thread::Yield(); // 让出时间片
|
||||
auto currentId = Thread::GetCurrentId();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Mutex](../mutex/mutex.md) - 互斥锁
|
||||
- [TaskSystem](../task-system/task-system.md) - 任务调度系统
|
||||
- [../threading/threading.md](../threading.md) - 模块总览
|
||||
40
docs/api/threading/thread/yield.md
Normal file
40
docs/api/threading/thread/yield.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Thread::Yield
|
||||
|
||||
```cpp
|
||||
static void Yield()
|
||||
```
|
||||
|
||||
让出当前线程的时间片,允许操作系统调度器将 CPU 时间分配给其他就绪线程。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**使用场景:**
|
||||
- 在自旋等待某个条件时调用,避免浪费 CPU 周期。
|
||||
- 在长时间循环中定期让出时间片,提高其他线程的响应性。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
volatile bool ready = false;
|
||||
|
||||
Thread worker;
|
||||
worker.Start([]() {
|
||||
ready = true;
|
||||
}, "WorkerThread");
|
||||
|
||||
// 忙等待,但定期让出时间片
|
||||
while (!ready) {
|
||||
Thread::Yield();
|
||||
}
|
||||
|
||||
worker.Join();
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Thread 总览](thread.md) - 返回类总览
|
||||
- [Sleep](sleep.md) - 线程休眠
|
||||
Reference in New Issue
Block a user