xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refactor Components API content

Browse Source
This commit is contained in:
ssdfasd
2026-03-27 16:15:00 +08:00
parent f0d6d4f41c
commit 9e66a81514
16 changed files with 1611 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/api/_meta/rebuild-status.md
View File

@@ -1,14 +1,14 @@
# API 文档重构状态
**生成时间**: `2026-03-26 21:30:11`
**生成时间**: `2026-03-27 16:00:15`
**来源**: `docs/api/_tools/audit_api_docs.py`
## 摘要
- Markdown 页面数（全部）: `2535`
- Markdown 页面数（canonical）: `2524`
- Public headers 数: `204`
- Markdown 页面数（全部）: `2625`
- Markdown 页面数（canonical）: `2612`
- Public headers 数: `221`
- 有效头文件引用数（全部）: `197`
- 有效头文件引用数（canonical）: `197`
- 无效头文件引用数: `0`
@@ -20,9 +20,9 @@
## 平行目录
- Canonical 根目录: `XCEngine`
- 源码目录节点数: `27`
- 源码目录节点数: `29`
- 已生成目录总览页节点数: `26`
- 缺失目录总览页节点数: `1`
- 缺失目录总览页节点数: `3`
- 支撑目录: `_meta, _tools`
## 模块覆盖
@@ -36,30 +36,49 @@
| `Input` | `5` | `5` | `0` |
| `Memory` | `5` | `5` | `0` |
| `Platform` | `11` | `11` | `0` |
| `RHI` | `68` | `68` | `0` |
| `Rendering` | `10` | `10` | `0` |
| `RHI` | `83` | `68` | `15` |
| `Rendering` | `11` | `10` | `1` |
| `Resources` | `13` | `13` | `0` |
| `Scene` | `3` | `2` | `1` |
| `Scripting` | `6` | `0` | `6` |
| `Scripting` | `7` | `0` | `7` |
| `Threading` | `10` | `10` | `0` |
## 元信息覆盖
| 字段 | 页面数 |
|------|--------|
| `命名空间` | `222` |
| `类型` | `222` |
| `描述` | `222` |
| `命名空间` | `307` |
| `类型` | `307` |
| `描述` | `307` |
| `头文件` | `197` |
## 缺失的平行目录总览页
- `XCEngine/RHI/Vulkan`
- `XCEngine/Scripting`
- `XCEngine/Scripting/Mono`
## 未覆盖的 public headers
- `XCEngine/RHI/Vulkan/VulkanBuffer.h`
- `XCEngine/RHI/Vulkan/VulkanCommandList.h`
- `XCEngine/RHI/Vulkan/VulkanCommandQueue.h`
- `XCEngine/RHI/Vulkan/VulkanCommon.h`
- `XCEngine/RHI/Vulkan/VulkanDescriptorPool.h`
- `XCEngine/RHI/Vulkan/VulkanDescriptorSet.h`
- `XCEngine/RHI/Vulkan/VulkanDevice.h`
- `XCEngine/RHI/Vulkan/VulkanFence.h`
- `XCEngine/RHI/Vulkan/VulkanPipelineLayout.h`
- `XCEngine/RHI/Vulkan/VulkanPipelineState.h`
- `XCEngine/RHI/Vulkan/VulkanResourceView.h`
- `XCEngine/RHI/Vulkan/VulkanSampler.h`
- `XCEngine/RHI/Vulkan/VulkanScreenshot.h`
- `XCEngine/RHI/Vulkan/VulkanSwapChain.h`
- `XCEngine/RHI/Vulkan/VulkanTexture.h`
- `XCEngine/Rendering/RenderMaterialUtility.h`
- `XCEngine/Scene/SceneRuntime.h`
- `XCEngine/Scripting/IScriptRuntime.h`
- `XCEngine/Scripting/Mono/MonoScriptRuntime.h`
- `XCEngine/Scripting/NullScriptRuntime.h`
- `XCEngine/Scripting/ScriptComponent.h`
- `XCEngine/Scripting/ScriptEngine.h`