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,28 @@
# ReadWriteLock::ReadWriteLock()
构造对象。
```cpp
ReadWriteLock() = default;
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,29 @@
# ReadWriteLock::~ReadWriteLock()
销毁对象并释放相关资源。
```cpp
~ReadWriteLock() = default;
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
// 对象离开作用域时会自动触发析构。
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,30 @@
# ReadWriteLock::ReadLock
公开方法,详见头文件声明。
```cpp
void ReadLock();
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
// 根据上下文补齐参数后调用 ReadWriteLock::ReadLock(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,30 @@
# ReadWriteLock::ReadUnlock
公开方法,详见头文件声明。
```cpp
void ReadUnlock();
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
// 根据上下文补齐参数后调用 ReadWriteLock::ReadUnlock(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,35 @@
# ReadWriteLock
**命名空间**: `XCEngine::Threading`
**类型**: `class`
**头文件**: `XCEngine/Threading/ReadWriteLock.h`
**描述**: 定义 `XCEngine/Threading` 子目录中的 `ReadWriteLock` public API。
## 概述
`ReadWriteLock.h``XCEngine/Threading` 子目录 下的 public header当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `ReadWriteLock` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [ReadWriteLock()](Constructor.md) | 构造对象。 |
| [~ReadWriteLock()](Destructor.md) | 销毁对象并释放相关资源。 |
| [ReadLock](ReadLock.md) | 公开方法,详见头文件声明。 |
| [ReadUnlock](ReadUnlock.md) | 公开方法,详见头文件声明。 |
| [WriteLock](WriteLock.md) | 公开方法,详见头文件声明。 |
| [WriteUnlock](WriteUnlock.md) | 公开方法,详见头文件声明。 |
## 相关文档
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

View File

@@ -0,0 +1,30 @@
# ReadWriteLock::WriteLock
公开方法,详见头文件声明。
```cpp
void WriteLock();
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
// 根据上下文补齐参数后调用 ReadWriteLock::WriteLock(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)

View File

@@ -0,0 +1,30 @@
# ReadWriteLock::WriteUnlock
公开方法,详见头文件声明。
```cpp
void WriteUnlock();
```
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Threading/ReadWriteLock.h>
void Example() {
XCEngine::Threading::ReadWriteLock object;
// 根据上下文补齐参数后调用 ReadWriteLock::WriteUnlock(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](ReadWriteLock.md)
- [返回模块目录](../Threading.md)