refactor api documentation structure

This commit is contained in:
2026-03-26 16:45:24 +08:00
parent 45842e961e
commit 6244b586bb
4389 changed files with 80504 additions and 69241 deletions

View File

@@ -0,0 +1,35 @@
# SpinLock
**命名空间**: `XCEngine::Threading`
**类型**: `class`
**头文件**: `XCEngine/Threading/SpinLock.h`
**描述**: 定义 `XCEngine/Threading` 子目录中的 `SpinLock` public API。
## 概述
`SpinLock.h``XCEngine/Threading` 子目录 下的 public header当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `SpinLock` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [Lock](Lock.md) | 公开方法,详见头文件声明。 |
| [Unlock](Unlock.md) | 公开方法,详见头文件声明。 |
| [TryLock](TryLock.md) | 公开方法,详见头文件声明。 |
| [lock](lock.md) | 公开方法,详见头文件声明。 |
| [unlock](unlock.md) | 公开方法,详见头文件声明。 |
| [try_lock](try_lock.md) | 公开方法,详见头文件声明。 |
## 相关文档
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引