2026-03-26 16:45:24 +08:00
|
|
|
|
# API 文档重构状态
|
|
|
|
|
|
|
2026-03-26 20:59:59 +08:00
|
|
|
|
**生成时间**: `2026-03-26 20:57:38`
|
2026-03-26 16:45:24 +08:00
|
|
|
|
|
|
|
|
|
|
**来源**: `docs/api/_tools/audit_api_docs.py`
|
|
|
|
|
|
|
|
|
|
|
|
## 摘要
|
|
|
|
|
|
|
2026-03-26 20:59:59 +08:00
|
|
|
|
- Markdown 页面数(全部): `2456`
|
|
|
|
|
|
- Markdown 页面数(canonical): `2446`
|
|
|
|
|
|
- Public headers 数: `204`
|
2026-03-26 16:45:24 +08:00
|
|
|
|
- 有效头文件引用数(全部): `185`
|
|
|
|
|
|
- 有效头文件引用数(canonical): `185`
|
|
|
|
|
|
- 无效头文件引用数: `0`
|
|
|
|
|
|
- 失效 `.md` 链接数: `0`
|
|
|
|
|
|
- 非 `.md` 相对链接数: `0`
|
|
|
|
|
|
- 旧模板页面数: `0`
|
|
|
|
|
|
- 扁平 header 页面数: `0`
|
|
|
|
|
|
|
|
|
|
|
|
## 平行目录
|
|
|
|
|
|
|
|
|
|
|
|
- Canonical 根目录: `XCEngine`
|
2026-03-26 20:59:59 +08:00
|
|
|
|
- 源码目录节点数: `27`
|
2026-03-26 16:45:24 +08:00
|
|
|
|
- 已生成目录总览页节点数: `24`
|
2026-03-26 20:59:59 +08:00
|
|
|
|
- 缺失目录总览页节点数: `3`
|
2026-03-26 16:45:24 +08:00
|
|
|
|
- 支撑目录: `_meta, _tools`
|
|
|
|
|
|
|
|
|
|
|
|
## 模块覆盖
|
|
|
|
|
|
|
|
|
|
|
|
| 模块 | Public headers | 已覆盖 | 未覆盖 |
|
|
|
|
|
|
|------|----------------|--------|--------|
|
|
|
|
|
|
| `Audio` | `11` | `11` | `0` |
|
2026-03-26 20:59:59 +08:00
|
|
|
|
| `Components` | `10` | `8` | `2` |
|
2026-03-26 16:45:24 +08:00
|
|
|
|
| `Core` | `42` | `42` | `0` |
|
|
|
|
|
|
| `Debug` | `10` | `10` | `0` |
|
|
|
|
|
|
| `Input` | `5` | `5` | `0` |
|
|
|
|
|
|
| `Memory` | `5` | `5` | `0` |
|
|
|
|
|
|
| `Platform` | `11` | `11` | `0` |
|
|
|
|
|
|
| `RHI` | `68` | `68` | `0` |
|
2026-03-26 20:59:59 +08:00
|
|
|
|
| `Rendering` | `10` | `0` | `10` |
|
2026-03-26 16:45:24 +08:00
|
|
|
|
| `Resources` | `13` | `13` | `0` |
|
2026-03-26 20:59:59 +08:00
|
|
|
|
| `Scene` | `3` | `2` | `1` |
|
|
|
|
|
|
| `Scripting` | `6` | `0` | `6` |
|
2026-03-26 16:45:24 +08:00
|
|
|
|
| `Threading` | `10` | `10` | `0` |
|
|
|
|
|
|
|
|
|
|
|
|
## 元信息覆盖
|
|
|
|
|
|
|
|
|
|
|
|
| 字段 | 页面数 |
|
|
|
|
|
|
|------|--------|
|
2026-03-26 17:27:30 +08:00
|
|
|
|
| `命名空间` | `208` |
|
|
|
|
|
|
| `类型` | `208` |
|
|
|
|
|
|
| `描述` | `208` |
|
2026-03-26 16:45:24 +08:00
|
|
|
|
| `头文件` | `185` |
|
2026-03-26 20:59:59 +08:00
|
|
|
|
|
|
|
|
|
|
## 缺失的平行目录总览页
|
|
|
|
|
|
|
|
|
|
|
|
- `XCEngine/Rendering`
|
|
|
|
|
|
- `XCEngine/Rendering/Pipelines`
|
|
|
|
|
|
- `XCEngine/Scripting`
|
|
|
|
|
|
|
|
|
|
|
|
## 未覆盖的 public headers
|
|
|
|
|
|
|
|
|
|
|
|
- `XCEngine/Components/MeshFilterComponent.h`
|
|
|
|
|
|
- `XCEngine/Components/MeshRendererComponent.h`
|
|
|
|
|
|
- `XCEngine/Rendering/Pipelines/BuiltinForwardPipeline.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderCameraData.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderContext.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderPipeline.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderPipelineAsset.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderResourceCache.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderSceneExtractor.h`
|
|
|
|
|
|
- `XCEngine/Rendering/RenderSurface.h`
|
|
|
|
|
|
- `XCEngine/Rendering/SceneRenderer.h`
|
|
|
|
|
|
- `XCEngine/Rendering/VisibleRenderObject.h`
|
|
|
|
|
|
- `XCEngine/Scene/SceneRuntime.h`
|
|
|
|
|
|
- `XCEngine/Scripting/IScriptRuntime.h`
|
|
|
|
|
|
- `XCEngine/Scripting/NullScriptRuntime.h`
|
|
|
|
|
|
- `XCEngine/Scripting/ScriptComponent.h`
|
|
|
|
|
|
- `XCEngine/Scripting/ScriptEngine.h`
|
|
|
|
|
|
- `XCEngine/Scripting/ScriptField.h`
|
|
|
|
|
|
- `XCEngine/Scripting/ScriptFieldStorage.h`
|