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:
2026-03-19 00:22:30 +08:00
parent d0e16962c8
commit dc850d7739
1012 changed files with 26673 additions and 9222 deletions

View File

@@ -0,0 +1,34 @@
# Mutex::Lock
```cpp
void Lock()
```
获取互斥锁。如果锁已被其他线程持有,则阻塞当前线程直到锁可用。
**参数:**
**返回:**
**复杂度:** 平均 O(1),最坏情况 O(n)n 为竞争线程数
**注意:**
- 同一线程不可重复 Lock 同一个 Mutex会导致死锁
- 建议使用 RAII 封装(如 std::lock_guard自动管理锁的释放。
**示例:**
```cpp
Threading::Mutex mtx;
int counter = 0;
void Increment() {
mtx.Lock();
++counter;
mtx.Unlock();
}
```
## 相关文档
- [Mutex 总览](mutex.md) - 返回类总览

View File

@@ -0,0 +1,54 @@
# Mutex
**命名空间**: `XCEngine::Threading`
**类型**: `class`
**头文件**: `XCEngine/Threading/Mutex.h`
**描述**: 互斥锁封装类,基于 `std::mutex` 实现,提供线程安全的互斥访问。
## 概述
`Mutex` 是对 `std::mutex` 的简单封装,提供了标准的 Lock/Unlock/TryLock 接口。它是 XCEngine 中最基础的同步原语,适用于保护共享数据的访问。
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Lock`](lock.md) | 获取锁(阻塞) |
| [`Unlock`](unlock.md) | 释放锁 |
| [`TryLock`](trylock.md) | 尝试获取锁(非阻塞,成功返回 true |
## STL 兼容方法
支持 `lock()``unlock()``try_lock()` 以兼容 STL 的 lockable 概念。
## 使用示例
```cpp
Threading::Mutex mtx;
int sharedData = 0;
// 线程安全地修改共享数据
void SafeIncrement() {
mtx.Lock();
++sharedData;
mtx.Unlock();
}
// 或使用 TryLock
void SafeTryIncrement() {
if (mtx.TryLock()) {
++sharedData;
mtx.Unlock();
}
}
```
## 相关文档
- [SpinLock](../spinlock/spinlock.md) - 自旋锁
- [ReadWriteLock](../readwritelock/readwritelock.md) - 读写锁
- [TaskSystem](../task-system/task-system.md) - 任务系统
- [../threading/threading.md](../threading.md) - 模块总览

View File

@@ -0,0 +1,36 @@
# Mutex::TryLock
```cpp
bool TryLock()
```
尝试获取互斥锁(非阻塞)。如果锁可用则立即获取并返回 true否则立即返回 false 而不阻塞。
**参数:**
**返回:** `bool` - 获取成功返回 true锁不可用返回 false
**复杂度:** O(1)
**使用场景:** 适用于需要尝试获取锁但不希望阻塞的场景,如实现无锁算法或避免死锁。
**示例:**
```cpp
Threading::Mutex mtx;
volatile bool updated = false;
void TryUpdate() {
if (mtx.TryLock()) {
updated = true;
mtx.Unlock();
printf("Update succeeded\n");
} else {
printf("Update skipped (lock held)\n");
}
}
```
## 相关文档
- [Mutex 总览](mutex.md) - 返回类总览

View File

@@ -0,0 +1,32 @@
# Mutex::Unlock
```cpp
void Unlock()
```
释放互斥锁,允许其他等待中的线程获取该锁。
**参数:**
**返回:**
**复杂度:** O(1)
**注意:** 必须在持有锁的线程中调用 Unlock。解锁一个未持有的锁将导致未定义行为。
**示例:**
```cpp
Threading::Mutex mtx;
std::vector<int> data;
void SafePush(int value) {
mtx.Lock();
data.push_back(value);
mtx.Unlock();
}
```
## 相关文档
- [Mutex 总览](mutex.md) - 返回类总览