93 lines
2.7 KiB
Markdown
93 lines
2.7 KiB
Markdown
# API 文档重构状态
|
||
|
||
**生成时间**: `2026-03-27 19:11:24`
|
||
|
||
**来源**: `docs/api/_tools/audit_api_docs.py`
|
||
|
||
## 摘要
|
||
|
||
- Markdown 页面数（全部）: `2629`
|
||
- Markdown 页面数（canonical）: `2610`
|
||
- Public headers 数: `227`
|
||
- 有效头文件引用数（全部）: `197`
|
||
- 有效头文件引用数（canonical）: `197`
|
||
- 无效头文件引用数: `0`
|
||
- 失效 `.md` 链接数: `0`
|
||
- 非 `.md` 相对链接数: `0`
|
||
- 旧模板页面数: `0`
|
||
- 扁平 header 页面数: `0`
|
||
|
||
## 平行目录
|
||
|
||
- Canonical 根目录: `XCEngine`
|
||
- 源码目录节点数: `29`
|
||
- 已生成目录总览页节点数: `26`
|
||
- 缺失目录总览页节点数: `3`
|
||
- 支撑目录: `_meta, _tools`
|
||
|
||
## 模块覆盖
|
||
|
||
| 模块 | Public headers | 已覆盖 | 未覆盖 |
|
||
|------|----------------|--------|--------|
|
||
| `Audio` | `11` | `11` | `0` |
|
||
| `Components` | `10` | `10` | `0` |
|
||
| `Core` | `42` | `42` | `0` |
|
||
| `Debug` | `10` | `10` | `0` |
|
||
| `Input` | `5` | `5` | `0` |
|
||
| `Memory` | `5` | `5` | `0` |
|
||
| `Platform` | `11` | `11` | `0` |
|
||
| `RHI` | `87` | `68` | `19` |
|
||
| `Rendering` | `13` | `10` | `3` |
|
||
| `Resources` | `13` | `13` | `0` |
|
||
| `Scene` | `3` | `2` | `1` |
|
||
| `Scripting` | `7` | `0` | `7` |
|
||
| `Threading` | `10` | `10` | `0` |
|
||
|
||
## 元信息覆盖
|
||
|
||
| 字段 | 页面数 |
|
||
|------|--------|
|
||
| `命名空间` | `305` |
|
||
| `类型` | `305` |
|
||
| `描述` | `305` |
|
||
| `头文件` | `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/VulkanFramebuffer.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanPipelineLayout.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanPipelineState.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanRenderPass.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanResourceView.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanSampler.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanScreenshot.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanShader.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanShaderCompiler.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanSwapChain.h`
|
||
- `XCEngine/RHI/Vulkan/VulkanTexture.h`
|
||
- `XCEngine/Rendering/CameraRenderRequest.h`
|
||
- `XCEngine/Rendering/CameraRenderer.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`
|
||
- `XCEngine/Scripting/ScriptField.h`
|
||
- `XCEngine/Scripting/ScriptFieldStorage.h`
|