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

docs: sync api and planning docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-08 16:07:03 +08:00
parent 08c3278e10
commit 31756847ab
1826 changed files with 44502 additions and 29645 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
docs/api/_meta/_scratch_audit_asset_material_batch4.md Normal file
View File

@@ -0,0 +1,147 @@
# API 文档重构状态
**生成时间**: `2026-04-04 00:13:21`
**来源**: `docs/api/_tools/audit_api_docs.py`
## 摘要
- Markdown 页面数（全部）: `3362`
- Markdown 页面数（canonical）: `3337`
- Public headers 数: `244`
- Editor source headers 数: `127`
- 有效头文件引用数（全部）: `244`
- 有效头文件引用数（canonical）: `244`
- 无效头文件引用数: `0`
- 有效源文件引用数（全部）: `125`
- 有效源文件引用数（Editor canonical）: `125`
- 无效源文件引用数: `1`
- 失效 `.md` 链接数: `70`
- 非 `.md` 相对链接数: `0`
- 旧模板页面数: `0`
- 扁平 header 页面数: `0`
- Canonical 显式过期符号残留数: `0`
- Editor 显式过期符号残留数: `0`
- Editor 残留 canonical 旧页面数: `0`
- Editor 高风险单页目录数: `0`
## 平行目录
- Canonical 根目录: `XCEngine`
- 源码目录节点数: `30`
- 已生成目录总览页节点数: `30`
- 缺失目录总览页节点数: `0`
- 支撑目录: `_meta, _tools`
## 模块覆盖
| 模块 | Public headers | 已覆盖 | 未覆盖 |
|------|----------------|--------|--------|
| `Audio` | `11` | `11` | `0` |
| `Components` | `10` | `10` | `0` |
| `Core` | `48` | `48` | `0` |
| `Debug` | `10` | `10` | `0` |
| `Input` | `5` | `5` | `0` |
| `Memory` | `5` | `5` | `0` |
| `Platform` | `11` | `11` | `0` |
| `RHI` | `87` | `87` | `0` |
| `Rendering` | `22` | `22` | `0` |
| `Resources` | `14` | `14` | `0` |
| `Scene` | `4` | `4` | `0` |
| `Scripting` | `7` | `7` | `0` |
| `Threading` | `10` | `10` | `0` |
## Editor 源文件页覆盖
| 模块 | Source headers | 已覆盖 | 未覆盖 |
|------|----------------|--------|--------|
| `(root)` | `3` | `3` | `0` |
| `Actions` | `9` | `9` | `0` |
| `Commands` | `4` | `4` | `0` |
| `ComponentEditors` | `10` | `10` | `0` |
| `Core` | `20` | `20` | `0` |
| `Layers` | `1` | `1` | `0` |
| `Layout` | `1` | `1` | `0` |
| `Managers` | `3` | `3` | `0` |
| `Platform` | `4` | `4` | `0` |
| `Scripting` | `3` | `3` | `0` |
| `UI` | `29` | `29` | `0` |
| `Utils` | `4` | `4` | `0` |
| `Viewport` | `26` | `24` | `2` |
| `panels` | `10` | `10` | `0` |
## 元信息覆盖
| 字段 | 页面数 |
|------|--------|
| `命名空间` | `2137` |
| `类型` | `2137` |
| `描述` | `424` |
| `头文件` | `1738` |
| `源文件` | `358` |
## 无效源文件引用
| 文档 | 源文件 |
|------|------|
| `XCEngine/Editor/Viewport/SceneViewportOverlayRenderer/SceneViewportOverlayRenderer.md` | `editor/src/Viewport/SceneViewportOverlayRenderer.h` |
## 失效 Markdown 链接
| 文档 | 目标 |
|------|------|
| `XCEngine/Audio/WindowsAudioBackend/Constructor.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Destructor.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/GetAvailableDevices.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/GetConfig.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/GetDeviceName.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/GetMasterVolume.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Initialize.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/IsMuted.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/IsRunning.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/ProcessAudio.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Resume.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/SetDevice.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/SetMasterVolume.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/SetMuted.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Shutdown.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Start.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Stop.md` | `WASAPIBackend.md` |
| `XCEngine/Audio/WindowsAudioBackend/Suspend.md` | `WASAPIBackend.md` |
| `XCEngine/Core/Math/Matrix3/Constructor.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Determinant.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Identity.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Inverse.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/OperatorMultiply.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/OperatorSubscript.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/RotationX.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/RotationY.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/RotationZ.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Scale.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Transpose.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix3/Zero.md` | `Matrix3x3.md` |
| `XCEngine/Core/Math/Matrix4/Constructor.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Decompose.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Determinant.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/GetRotation.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/GetScale.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/GetTranslation.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Identity.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Inverse.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/LookAt.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/MultiplyPoint.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/MultiplyVector.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/OperatorMultiply.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/OperatorSubscript.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Orthographic.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Perspective.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Rotation.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/RotationX.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/RotationY.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/RotationZ.md` | `Matrix4x4.md` |
| `XCEngine/Core/Math/Matrix4/Scale.md` | `Matrix4x4.md` |
## 未覆盖的 Editor 源文件页
- `editor/src/Viewport/SceneViewportHudOverlay.h`
- `editor/src/Viewport/SceneViewportInteractionResolver.h`

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

@@ -1,20 +1,20 @@
# API 文档重构状态
**生成时间**: `2026-04-03 15:30:08`
**生成时间**: `2026-04-07 01:26:32`
**来源**: `docs/api/_tools/audit_api_docs.py`
## 摘要
- Markdown 页面数（全部）: `3324`
- Markdown 页面数（canonical）: `3298`
- Public headers 数: `244`
- Editor source headers 数: `124`
- 有效头文件引用数（全部）: `244`
- 有效头文件引用数（canonical）: `244`
- Markdown 页面数（全部）: `3753`
- Markdown 页面数（canonical）: `3725`
- Public headers 数: `304`
- Editor source headers 数: `142`
- 有效头文件引用数（全部）: `304`
- 有效头文件引用数（canonical）: `304`
- 无效头文件引用数: `0`
- 有效源文件引用数（全部）: `124`
- 有效源文件引用数（Editor canonical）: `124`
- 有效源文件引用数（全部）: `142`
- 有效源文件引用数（Editor canonical）: `142`
- 无效源文件引用数: `0`
- 失效 `.md` 链接数: `0`
- 非 `.md` 相对链接数: `0`
@@ -28,8 +28,8 @@
## 平行目录
- Canonical 根目录: `XCEngine`
- 源码目录节点数: `30`
- 已生成目录总览页节点数: `30`
- 源码目录节点数: `48`
- 已生成目录总览页节点数: `48`
- 缺失目录总览页节点数: `0`
- 支撑目录: `_meta, _tools`
@@ -44,12 +44,13 @@
| `Input` | `5` | `5` | `0` |
| `Memory` | `5` | `5` | `0` |
| `Platform` | `11` | `11` | `0` |
| `RHI` | `87` | `87` | `0` |
| `Rendering` | `22` | `22` | `0` |
| `Resources` | `14` | `14` | `0` |
| `RHI` | `88` | `88` | `0` |
| `Rendering` | `38` | `38` | `0` |
| `Resources` | `20` | `20` | `0` |
| `Scene` | `4` | `4` | `0` |
| `Scripting` | `7` | `7` | `0` |
| `Threading` | `10` | `10` | `0` |
| `UI` | `37` | `37` | `0` |
## Editor 源文件页覆盖
@@ -63,19 +64,20 @@
| `Layers` | `1` | `1` | `0` |
| `Layout` | `1` | `1` | `0` |
| `Managers` | `3` | `3` | `0` |
| `Platform` | `4` | `4` | `0` |
| `Platform` | `5` | `5` | `0` |
| `Scripting` | `3` | `3` | `0` |
| `UI` | `29` | `29` | `0` |
| `Utils` | `4` | `4` | `0` |
| `Viewport` | `23` | `23` | `0` |
| `panels` | `10` | `10` | `0` |
| `Viewport` | `37` | `37` | `0` |
| `XCUIBackend` | `2` | `2` | `0` |
| `panels` | `11` | `11` | `0` |
## 元信息覆盖
| 字段 | 页面数 |
|------|--------|
| `命名空间` | `941` |
| `类型` | `941` |
| `描述` | `417` |
| `头文件` | `552` |
| `源文件` | `348` |
| `命名空间` | `2471` |
| `类型` | `2471` |
| `描述` | `530` |
| `头文件` | `1892` |
| `源文件` | `512` |