refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# WindowsInputModule
|
||||
|
||||
**命名空间**: `XCEngine::Input::Platform`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Platform/Windows/WindowsInputModule.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Platform/Windows` 子目录中的 `WindowsInputModule` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`WindowsInputModule.h` 是 `XCEngine/Platform/Windows` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `WindowsInputModule` | `class` | 继承自 `InputModule` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [WindowsInputModule()](Constructor.md) | 构造对象。 |
|
||||
| [~WindowsInputModule()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Initialize](Initialize.md) | 初始化内部状态。 |
|
||||
| [Shutdown](Shutdown.md) | 关闭并清理内部状态。 |
|
||||
| [PumpEvents](PumpEvents.md) | 公开方法,详见头文件声明。 |
|
||||
| [HandleMessage](HandleMessage.md) | 公开方法,详见头文件声明。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Windows.md) - 返回 `Windows` 平行目录
|
||||
- [API 总索引](../../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user