fix: improve doc link navigation and tree display

- Fix link resolution with proper relative/absolute path handling
- Improve link styling with underline decoration
- Hide leaf nodes from tree, only show directories
- Fix log file path for packaged app
This commit is contained in:
2026-03-19 12:44:08 +08:00
parent e003fe6513
commit 58a83f445a
1012 changed files with 56880 additions and 22 deletions

View File

@@ -0,0 +1,35 @@
# SpinLock::Lock
```cpp
void Lock()
```
获取自旋锁。如果锁已被其他线程持有则使用忙等待spin持续轮询直到获取到锁。
**参数:**
**返回:**
**复杂度:** 平均 O(1),最坏情况取决于竞争程度
**注意:**
- 适用于临界区极短(几个 CPU 指令)的场景,避免线程切换开销。
- 在锁持有时间较长或多核竞争激烈时,会浪费大量 CPU 周期,此时应使用 Mutex。
- 同一线程不可重复 Lock 同一个 SpinLock。
**示例:**
```cpp
Threading::SpinLock spinLock;
int64_t fastCounter = 0;
void IncrementFast() {
spinLock.Lock();
++fastCounter;
spinLock.Unlock();
}
```
## 相关文档
- [SpinLock 总览](spinlock.md) - 返回类总览

View File

@@ -0,0 +1,53 @@
# SpinLock
**命名空间**: `XCEngine::Threading`
**类型**: `class`
**头文件**: `XCEngine/Threading/SpinLock.h`
**描述**: 自旋锁封装类,使用原子操作实现,适用于保护极短的临界区。
## 概述
`SpinLock` 是一个轻量级的自旋锁实现,使用 `std::atomic_flag` 的 test-and-set 操作。它在获取锁失败时不断轮询,不会导致线程切换,非常适合保护非常短的临界区(如简单的计数器递增)。
## 公共方法
| 方法 | 描述 |
|------|------|
| [`Lock`](lock.md) | 获取锁(忙等待) |
| [`Unlock`](unlock.md) | 释放锁 |
| [`TryLock`](trylock.md) | 尝试获取锁(非阻塞) |
## STL 兼容方法
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念。**注意**:这些方法为非 `const` 成员函数。
## 使用示例
```cpp
Threading::SpinLock spinLock;
int counter = 0;
// 保护极短的临界区
void FastIncrement() {
spinLock.Lock();
++counter;
spinLock.Unlock();
}
// TryLock 用法
void SafeIncrement() {
if (spinLock.TryLock()) {
++counter;
spinLock.Unlock();
}
}
```
## 相关文档
- [Mutex](../mutex/mutex.md) - 互斥锁
- [ReadWriteLock](../readwritelock/readwritelock.md) - 读写锁
- [../threading/threading.md](../threading.md) - 模块总览

View File

@@ -0,0 +1,31 @@
# SpinLock::TryLock
```cpp
bool TryLock()
```
尝试获取自旋锁(非阻塞)。如果锁可用则立即获取并返回 true否则立即返回 false。
**参数:**
**返回:** `bool` - 获取成功返回 true锁不可用返回 false
**复杂度:** O(1)
**示例:**
```cpp
Threading::SpinLock spinLock;
int64_t counter = 0;
void TryIncrement() {
if (spinLock.TryLock()) {
++counter;
spinLock.Unlock();
}
}
```
## 相关文档
- [SpinLock 总览](spinlock.md) - 返回类总览

View File

@@ -0,0 +1,32 @@
# SpinLock::Unlock
```cpp
void Unlock()
```
释放自旋锁,允许其他等待中的线程获取该锁。
**参数:**
**返回:**
**复杂度:** O(1)
**注意:** 必须在持有锁的线程中调用 Unlock。
**示例:**
```cpp
Threading::SpinLock spinLock;
int64_t counter = 0;
void SafeAdd(int64_t value) {
spinLock.Lock();
counter += value;
spinLock.Unlock();
}
```
## 相关文档
- [SpinLock 总览](spinlock.md) - 返回类总览