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

View File

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

View File

@@ -0,0 +1,31 @@
# InputModule::Initialize
初始化内部状态。
```cpp
virtual void Initialize(void* windowHandle) = 0;
```
该方法声明于 `XCEngine/Input/InputModule.h`,当前页面用于固定 `InputModule` 类目录下的方法级 canonical 路径。
**参数:**
- `windowHandle` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputModule.h>
void Example() {
XCEngine::Input::InputModule object;
// 根据上下文补齐参数后调用 InputModule::Initialize(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputModule.md)
- [返回模块目录](../Input.md)

View File

@@ -0,0 +1,34 @@
# InputModule
**命名空间**: `XCEngine::Input`
**类型**: `class (abstract)`
**头文件**: `XCEngine/Input/InputModule.h`
**描述**: 定义 `XCEngine/Input` 子目录中的 `InputModule` public API。
## 概述
`InputModule.h``XCEngine/Input` 子目录 下的 public header当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
## 声明概览
| 声明 | 类型 | 说明 |
|------|------|------|
| `InputModule` | `class` | 头文件中的公开声明。 |
## 公共方法
| 方法 | 描述 |
|------|------|
| [~InputModule()](Destructor.md) | 销毁对象并释放相关资源。 |
| [Initialize](Initialize.md) | 初始化内部状态。 |
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
| [PumpEvents](PumpEvents.md) | 公开方法,详见头文件声明。 |
| [HandleMessage](HandleMessage.md) | 公开方法,详见头文件声明。 |
## 相关文档
- [当前目录](../Input.md) - 返回 `Input` 平行目录
- [API 总索引](../../../main.md) - 返回顶层索引

View File

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

View File

@@ -0,0 +1,30 @@
# InputModule::Shutdown
关闭并清理内部状态。
```cpp
virtual void Shutdown() = 0;
```
该方法声明于 `XCEngine/Input/InputModule.h`,当前页面用于固定 `InputModule` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Input/InputModule.h>
void Example() {
XCEngine::Input::InputModule object;
// 根据上下文补齐参数后调用 InputModule::Shutdown(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](InputModule.md)
- [返回模块目录](../Input.md)