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

View File

@@ -0,0 +1,31 @@
# WindowsWindow::Create
创建新对象或资源。
```cpp
bool Create(const WindowDesc& desc) override;
```
该方法声明于 `XCEngine/Platform/Windows/WindowsWindow.h`,当前页面用于固定 `WindowsWindow` 类目录下的方法级 canonical 路径。
**参数:**
- `desc` - 参数语义详见头文件声明。
**返回:** `bool` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Platform/Windows/WindowsWindow.h>
void Example() {
XCEngine::Platform::WindowsWindow object;
// 根据上下文补齐参数后调用 WindowsWindow::Create(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](WindowsWindow.md)
- [返回模块目录](../Windows.md)

View File

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

View File

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

View File

@@ -0,0 +1,30 @@
# WindowsWindow::GetHandle
获取相关状态或对象。
```cpp
WindowHandle GetHandle() const override;
```
该方法声明于 `XCEngine/Platform/Windows/WindowsWindow.h`,当前页面用于固定 `WindowsWindow` 类目录下的方法级 canonical 路径。
**参数:** 无。
**返回:** `WindowHandle` - 返回值语义详见头文件声明。
**示例:**
```cpp
#include <XCEngine/Platform/Windows/WindowsWindow.h>
void Example() {
XCEngine::Platform::WindowsWindow object;
// 根据上下文补齐参数后调用 WindowsWindow::GetHandle(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](WindowsWindow.md)
- [返回模块目录](../Windows.md)

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,31 @@
# WindowsWindow::SetFullscreen
设置相关状态或配置。
```cpp
void SetFullscreen(bool fullscreen) override;
```
该方法声明于 `XCEngine/Platform/Windows/WindowsWindow.h`,当前页面用于固定 `WindowsWindow` 类目录下的方法级 canonical 路径。
**参数:**
- `fullscreen` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Platform/Windows/WindowsWindow.h>
void Example() {
XCEngine::Platform::WindowsWindow object;
// 根据上下文补齐参数后调用 WindowsWindow::SetFullscreen(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](WindowsWindow.md)
- [返回模块目录](../Windows.md)

View File

@@ -0,0 +1,31 @@
# WindowsWindow::SetMessageCallback
设置相关状态或配置。
```cpp
void SetMessageCallback(std::function<void(HWND, UINT, WPARAM, LPARAM)> callback);
```
该方法声明于 `XCEngine/Platform/Windows/WindowsWindow.h`,当前页面用于固定 `WindowsWindow` 类目录下的方法级 canonical 路径。
**参数:**
- `callback` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Platform/Windows/WindowsWindow.h>
void Example() {
XCEngine::Platform::WindowsWindow object;
// 根据上下文补齐参数后调用 WindowsWindow::SetMessageCallback(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](WindowsWindow.md)
- [返回模块目录](../Windows.md)

View File

@@ -0,0 +1,31 @@
# WindowsWindow::SetTitle
设置相关状态或配置。
```cpp
void SetTitle(const Containers::String& title) override;
```
该方法声明于 `XCEngine/Platform/Windows/WindowsWindow.h`,当前页面用于固定 `WindowsWindow` 类目录下的方法级 canonical 路径。
**参数:**
- `title` - 参数语义详见头文件声明。
**返回:** `void` - 无返回值。
**示例:**
```cpp
#include <XCEngine/Platform/Windows/WindowsWindow.h>
void Example() {
XCEngine::Platform::WindowsWindow object;
// 根据上下文补齐参数后调用 WindowsWindow::SetTitle(...)。
(void)object;
}
```
## 相关文档
- [返回类总览](WindowsWindow.md)
- [返回模块目录](../Windows.md)

View File

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

View File

@@ -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) - 返回顶层索引