refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
# ComponentFactoryRegistry
|
||||
|
||||
**命名空间**: `XCEngine::Components`
|
||||
|
||||
**类型**: `class (singleton)`
|
||||
|
||||
**头文件**: `XCEngine/Components/ComponentFactoryRegistry.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Components` 子目录中的 `ComponentFactoryRegistry` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`ComponentFactoryRegistry.h` 是 `XCEngine/Components` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `ComponentFactoryRegistry` | `class` | 头文件中的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [Get](Get.md) | 获取相关状态或对象。 |
|
||||
| [RegisterFactory](RegisterFactory.md) | 注册对象、回调或映射。 |
|
||||
| [CreateComponent](CreateComponent.md) | 创建新对象或资源。 |
|
||||
| [IsRegistered](IsRegistered.md) | 查询当前状态。 |
|
||||
| [GetRegisteredTypes](GetRegisteredTypes.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Components.md) - 返回 `Components` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user