refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
# WindowsWindow
|
||||
|
||||
**命名空间**: `XCEngine::Platform`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Platform/Windows/WindowsWindow.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Platform/Windows` 子目录中的 `WindowsWindow` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`WindowsWindow.h` 是 `XCEngine/Platform/Windows` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `WindowsWindow` | `class` | 继承自 `Window` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [WindowsWindow()](Constructor.md) | 构造对象。 |
|
||||
| [~WindowsWindow()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Create](Create.md) | 创建新对象或资源。 |
|
||||
| [Destroy](Destroy.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetHandle](GetHandle.md) | 获取相关状态或对象。 |
|
||||
| [PumpEvents](PumpEvents.md) | 公开方法,详见头文件声明。 |
|
||||
| [SetTitle](SetTitle.md) | 设置相关状态或配置。 |
|
||||
| [SetFullscreen](SetFullscreen.md) | 设置相关状态或配置。 |
|
||||
| [IsFullscreen](IsFullscreen.md) | 查询当前状态。 |
|
||||
| [Minimize](Minimize.md) | 公开方法,详见头文件声明。 |
|
||||
| [Maximize](Maximize.md) | 公开方法,详见头文件声明。 |
|
||||
| [Restore](Restore.md) | 公开方法,详见头文件声明。 |
|
||||
| [ShouldClose](ShouldClose.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetNativeHandle](GetNativeHandle.md) | 获取相关状态或对象。 |
|
||||
| [SetMessageCallback](SetMessageCallback.md) | 设置相关状态或配置。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Windows.md) - 返回 `Windows` 平行目录
|
||||
- [API 总索引](../../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user