refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,28 @@
|
||||
# WindowsInputModule::WindowsInputModule()
|
||||
|
||||
构造对象。
|
||||
|
||||
```cpp
|
||||
WindowsInputModule();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -0,0 +1,29 @@
|
||||
# WindowsInputModule::~WindowsInputModule()
|
||||
|
||||
销毁对象并释放相关资源。
|
||||
|
||||
```cpp
|
||||
virtual ~WindowsInputModule();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
// 对象离开作用域时会自动触发析构。
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -0,0 +1,34 @@
|
||||
# WindowsInputModule::HandleMessage
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void HandleMessage(size_t hwnd, unsigned int msg, size_t wParam, size_t lParam) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `hwnd` - 参数语义详见头文件声明。
|
||||
- `msg` - 参数语义详见头文件声明。
|
||||
- `wParam` - 参数语义详见头文件声明。
|
||||
- `lParam` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
// 根据上下文补齐参数后调用 WindowsInputModule::HandleMessage(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -0,0 +1,31 @@
|
||||
# WindowsInputModule::Initialize
|
||||
|
||||
初始化内部状态。
|
||||
|
||||
```cpp
|
||||
void Initialize(void* windowHandle) override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:**
|
||||
- `windowHandle` - 参数语义详见头文件声明。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
// 根据上下文补齐参数后调用 WindowsInputModule::Initialize(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# WindowsInputModule::PumpEvents
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
|
||||
```cpp
|
||||
void PumpEvents() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
// 根据上下文补齐参数后调用 WindowsInputModule::PumpEvents(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -0,0 +1,30 @@
|
||||
# WindowsInputModule::Shutdown
|
||||
|
||||
关闭并清理内部状态。
|
||||
|
||||
```cpp
|
||||
void Shutdown() override;
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Platform/Windows/WindowsInputModule.h`,当前页面用于固定 `WindowsInputModule` 类目录下的方法级 canonical 路径。
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Platform/Windows/WindowsInputModule.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Input::Platform::WindowsInputModule object;
|
||||
// 根据上下文补齐参数后调用 WindowsInputModule::Shutdown(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](WindowsInputModule.md)
|
||||
- [返回模块目录](../Windows.md)
|
||||
@@ -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