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,36 @@
# ReadWriteLock::ReadLock
```cpp
void ReadLock()
```
获取读锁。如果有写者持有锁或正在等待写锁,当前线程将阻塞,直到所有写者完成。
**参数:**
**返回:**
**复杂度:** 平均 O(1)
**注意:**
- 多个读者可以同时持有读锁。
- 写锁具有优先权——正在等待的写者会阻塞新的读者,防止写者饥饿。
- 读锁不可重入,同一线程不可嵌套持有读锁(会导致死锁)。
**示例:**
```cpp
ReadWriteLock rwLock;
int sharedValue = 0;
int ReadValue() {
rwLock.ReadLock();
int value = sharedValue;
rwLock.ReadUnlock();
return value;
}
```
## 相关文档
- [ReadWriteLock 总览](readwritelock.md) - 返回类总览

View File

@@ -0,0 +1,33 @@
# ReadWriteLock::ReadUnlock
```cpp
void ReadUnlock()
```
释放读锁。如果这是最后一个读者,将唤醒等待中的写者。
**参数:**
**返回:**
**复杂度:** O(1)
**注意:** 必须与 ReadLock 配对使用,且在持有读锁的线程中调用。
**示例:**
```cpp
ReadWriteLock rwLock;
float sharedData = 0.0f;
float GetData() {
rwLock.ReadLock();
float data = sharedData;
rwLock.ReadUnlock();
return data;
}
```
## 相关文档
- [ReadWriteLock 总览](readwritelock.md) - 返回类总览

View File

@@ -0,0 +1,57 @@
# ReadWriteLock
**命名空间**: `XCEngine::Threading`
**类型**: `class`
**头文件**: `XCEngine/Threading/ReadWriteLock.h`
**描述**: 读写锁实现,支持多个并发读取或单一写入,提高读多写少场景的并发性能。
## 概述
`ReadWriteLock` 实现了一个经典的读写锁。它允许多个线程同时持有读锁,但在有写锁时,所有读锁都必须释放,写锁为独占访问。这对于读操作远多于写操作的共享数据非常有效。
## 公共方法
### 读锁
| 方法 | 描述 |
|------|------|
| [`ReadLock`](readlock.md) | 获取读锁(可重入,支持多个并发读者) |
| [`ReadUnlock`](readunlock.md) | 释放读锁 |
### 写锁
| 方法 | 描述 |
|------|------|
| [`WriteLock`](writelock.md) | 获取写锁(独占,阻塞所有读者和写者) |
| [`WriteUnlock`](writeunlock.md) | 释放写锁 |
## 使用示例
```cpp
Threading::ReadWriteLock rwLock;
Containers::HashMap<String, int> sharedMap;
// 读操作(多个线程可同时读)
int* ReadData(const String& key) {
rwLock.ReadLock();
int* value = sharedMap.Find(key);
rwLock.ReadUnlock();
return value;
}
// 写操作(独占)
void WriteData(const String& key, int value) {
rwLock.WriteLock();
sharedMap.Insert(key, value);
rwLock.WriteUnlock();
}
```
## 相关文档
- [Mutex](../mutex/mutex.md) - 互斥锁
- [SpinLock](../spinlock/spinlock.md) - 自旋锁
- [../threading/threading.md](../threading.md) - 模块总览

View File

@@ -0,0 +1,35 @@
# ReadWriteLock::WriteLock
```cpp
void WriteLock()
```
获取写锁(独占)。如果有读者持有锁或有其他写者正在等待,当前线程将阻塞,直到获得独占访问权。
**参数:**
**返回:**
**复杂度:** 平均 O(1),写者饥饿时可能 O(n)
**注意:**
- 写锁为独占访问,持有期间不允许任何读锁或写锁。
- 写锁具有优先权,会阻塞后续到达的读者。
- 同一线程不可重复 WriteLock。
**示例:**
```cpp
ReadWriteLock rwLock;
std::vector<int> buffer;
void Append(int value) {
rwLock.WriteLock();
buffer.push_back(value);
rwLock.WriteUnlock();
}
```
## 相关文档
- [ReadWriteLock 总览](readwritelock.md) - 返回类总览

View File

@@ -0,0 +1,32 @@
# ReadWriteLock::WriteUnlock
```cpp
void WriteUnlock()
```
释放写锁。唤醒所有等待中的读者和下一个写者。
**参数:**
**返回:**
**复杂度:** O(1)
**注意:** 必须在持有写锁的线程中调用。
**示例:**
```cpp
ReadWriteLock rwLock;
std::unordered_map<String, int> cache;
void UpdateCache(const String& key, int value) {
rwLock.WriteLock();
cache[key] = value;
rwLock.WriteUnlock();
}
```
## 相关文档
- [ReadWriteLock 总览](readwritelock.md) - 返回类总览