docs(api): record editor stale-page cleanup audit
This commit is contained in:
@@ -1,20 +1,20 @@
|
|||||||
# API 文档重构状态
|
# API 文档重构状态
|
||||||
|
|
||||||
**生成时间**: `2026-04-07 01:26:32`
|
**生成时间**: `2026-04-10 00:00:52`
|
||||||
|
|
||||||
**来源**: `docs/api/_tools/audit_api_docs.py`
|
**来源**: `docs/api/_tools/audit_api_docs.py`
|
||||||
|
|
||||||
## 摘要
|
## 摘要
|
||||||
|
|
||||||
- Markdown 页面数(全部): `3753`
|
- Markdown 页面数(全部): `3794`
|
||||||
- Markdown 页面数(canonical): `3725`
|
- Markdown 页面数(canonical): `3766`
|
||||||
- Public headers 数: `304`
|
- Public headers 数: `313`
|
||||||
- Editor source headers 数: `142`
|
- Editor source headers 数: `144`
|
||||||
- 有效头文件引用数(全部): `304`
|
- 有效头文件引用数(全部): `313`
|
||||||
- 有效头文件引用数(canonical): `304`
|
- 有效头文件引用数(canonical): `313`
|
||||||
- 无效头文件引用数: `0`
|
- 无效头文件引用数: `0`
|
||||||
- 有效源文件引用数(全部): `142`
|
- 有效源文件引用数(全部): `144`
|
||||||
- 有效源文件引用数(Editor canonical): `142`
|
- 有效源文件引用数(Editor canonical): `144`
|
||||||
- 无效源文件引用数: `0`
|
- 无效源文件引用数: `0`
|
||||||
- 失效 `.md` 链接数: `0`
|
- 失效 `.md` 链接数: `0`
|
||||||
- 非 `.md` 相对链接数: `0`
|
- 非 `.md` 相对链接数: `0`
|
||||||
@@ -28,8 +28,8 @@
|
|||||||
## 平行目录
|
## 平行目录
|
||||||
|
|
||||||
- Canonical 根目录: `XCEngine`
|
- Canonical 根目录: `XCEngine`
|
||||||
- 源码目录节点数: `48`
|
- 源码目录节点数: `49`
|
||||||
- 已生成目录总览页节点数: `48`
|
- 已生成目录总览页节点数: `49`
|
||||||
- 缺失目录总览页节点数: `0`
|
- 缺失目录总览页节点数: `0`
|
||||||
- 支撑目录: `_meta, _tools`
|
- 支撑目录: `_meta, _tools`
|
||||||
|
|
||||||
@@ -38,19 +38,19 @@
|
|||||||
| 模块 | Public headers | 已覆盖 | 未覆盖 |
|
| 模块 | Public headers | 已覆盖 | 未覆盖 |
|
||||||
|------|----------------|--------|--------|
|
|------|----------------|--------|--------|
|
||||||
| `Audio` | `11` | `11` | `0` |
|
| `Audio` | `11` | `11` | `0` |
|
||||||
| `Components` | `10` | `10` | `0` |
|
| `Components` | `11` | `11` | `0` |
|
||||||
| `Core` | `48` | `48` | `0` |
|
| `Core` | `48` | `48` | `0` |
|
||||||
| `Debug` | `10` | `10` | `0` |
|
| `Debug` | `10` | `10` | `0` |
|
||||||
| `Input` | `5` | `5` | `0` |
|
| `Input` | `5` | `5` | `0` |
|
||||||
| `Memory` | `5` | `5` | `0` |
|
| `Memory` | `5` | `5` | `0` |
|
||||||
| `Platform` | `11` | `11` | `0` |
|
| `Platform` | `11` | `11` | `0` |
|
||||||
| `RHI` | `88` | `88` | `0` |
|
| `RHI` | `88` | `88` | `0` |
|
||||||
| `Rendering` | `38` | `38` | `0` |
|
| `Rendering` | `42` | `42` | `0` |
|
||||||
| `Resources` | `20` | `20` | `0` |
|
| `Resources` | `22` | `22` | `0` |
|
||||||
| `Scene` | `4` | `4` | `0` |
|
| `Scene` | `4` | `4` | `0` |
|
||||||
| `Scripting` | `7` | `7` | `0` |
|
| `Scripting` | `7` | `7` | `0` |
|
||||||
| `Threading` | `10` | `10` | `0` |
|
| `Threading` | `10` | `10` | `0` |
|
||||||
| `UI` | `37` | `37` | `0` |
|
| `UI` | `39` | `39` | `0` |
|
||||||
|
|
||||||
## Editor 源文件页覆盖
|
## Editor 源文件页覆盖
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@
|
|||||||
| `(root)` | `3` | `3` | `0` |
|
| `(root)` | `3` | `3` | `0` |
|
||||||
| `Actions` | `9` | `9` | `0` |
|
| `Actions` | `9` | `9` | `0` |
|
||||||
| `Commands` | `4` | `4` | `0` |
|
| `Commands` | `4` | `4` | `0` |
|
||||||
| `ComponentEditors` | `10` | `10` | `0` |
|
| `ComponentEditors` | `11` | `11` | `0` |
|
||||||
| `Core` | `20` | `20` | `0` |
|
| `Core` | `20` | `20` | `0` |
|
||||||
| `Layers` | `1` | `1` | `0` |
|
| `Layers` | `1` | `1` | `0` |
|
||||||
| `Layout` | `1` | `1` | `0` |
|
| `Layout` | `1` | `1` | `0` |
|
||||||
@@ -70,14 +70,14 @@
|
|||||||
| `Utils` | `4` | `4` | `0` |
|
| `Utils` | `4` | `4` | `0` |
|
||||||
| `Viewport` | `37` | `37` | `0` |
|
| `Viewport` | `37` | `37` | `0` |
|
||||||
| `XCUIBackend` | `2` | `2` | `0` |
|
| `XCUIBackend` | `2` | `2` | `0` |
|
||||||
| `panels` | `11` | `11` | `0` |
|
| `panels` | `12` | `12` | `0` |
|
||||||
|
|
||||||
## 元信息覆盖
|
## 元信息覆盖
|
||||||
|
|
||||||
| 字段 | 页面数 |
|
| 字段 | 页面数 |
|
||||||
|------|--------|
|
|------|--------|
|
||||||
| `命名空间` | `2471` |
|
| `命名空间` | `2492` |
|
||||||
| `类型` | `2471` |
|
| `类型` | `2492` |
|
||||||
| `描述` | `530` |
|
| `描述` | `551` |
|
||||||
| `头文件` | `1892` |
|
| `头文件` | `1903` |
|
||||||
| `源文件` | `512` |
|
| `源文件` | `520` |
|
||||||
|
|||||||
@@ -24,7 +24,7 @@
|
|||||||
|----|------|----------|----------|------|------|--------|
|
|----|------|----------|----------|------|------|--------|
|
||||||
| `R1` | Rendering / 重复目录归位 | 把旧顶层 `CameraRenderer`、`SceneRenderer`、`CameraRenderRequest`、`SceneRenderRequestPlanner`、`SceneRenderRequestUtils`、`RenderCameraData`、`RenderResourceCache`、`RenderSceneExtractor`、`RenderSceneUtility` 合并到真实子模块位置 | `docs/api/XCEngine/Rendering/**` | `medium` | `pending` | |
|
| `R1` | Rendering / 重复目录归位 | 把旧顶层 `CameraRenderer`、`SceneRenderer`、`CameraRenderRequest`、`SceneRenderRequestPlanner`、`SceneRenderRequestUtils`、`RenderCameraData`、`RenderResourceCache`、`RenderSceneExtractor`、`RenderSceneUtility` 合并到真实子模块位置 | `docs/api/XCEngine/Rendering/**` | `medium` | `pending` | |
|
||||||
| `R2` | Rendering / 旧命名残留审计 | 处理 `ObjectIdEncoding`、`ObjectIdPass`、`RenderMaterialUtility`、`VisibleRenderObject`,判定迁移到哪里或删除 | `docs/api/XCEngine/Rendering/**` | `medium` | `pending` | |
|
| `R2` | Rendering / 旧命名残留审计 | 处理 `ObjectIdEncoding`、`ObjectIdPass`、`RenderMaterialUtility`、`VisibleRenderObject`,判定迁移到哪里或删除 | `docs/api/XCEngine/Rendering/**` | `medium` | `pending` | |
|
||||||
| `E1` | Editor / 历史失效页清理 | 移除或降级 `XCUIDemoPanel`,修正 `panels.md`、`ImGuiTransitionBackend.md` 等反向链接 | `docs/api/XCEngine/Editor/panels/**` | `low` | `pending` | |
|
| `E1` | Editor / 历史失效页清理 | 移除 `XCUIDemoPanel` canonical 页面,修正 `panels.md`、`ImGuiTransitionBackend.md` 等反向链接 | `docs/api/XCEngine/Editor/panels/**` | `low` | `completed` | 当前会话 |
|
||||||
| `V1` | Resources / Volume | 建立 `Volume.md`、`VolumeField.md`、`VolumeFieldLoader.md`,同步 `Resources.md` | `docs/api/XCEngine/Resources/Volume/**` | `low` | `pending` | |
|
| `V1` | Resources / Volume | 建立 `Volume.md`、`VolumeField.md`、`VolumeFieldLoader.md`,同步 `Resources.md` | `docs/api/XCEngine/Resources/Volume/**` | `low` | `pending` | |
|
||||||
| `V2` | Components / Volume | 建立 `VolumeRendererComponent.md`,同步 `Components.md` | `docs/api/XCEngine/Components/VolumeRendererComponent/**` | `low` | `pending` | |
|
| `V2` | Components / Volume | 建立 `VolumeRendererComponent.md`,同步 `Components.md` | `docs/api/XCEngine/Components/VolumeRendererComponent/**` | `low` | `pending` | |
|
||||||
| `V3` | Rendering / Volume FrameData | 建立 `VisibleVolumeItem.md`,同步 `FrameData.md` | `docs/api/XCEngine/Rendering/FrameData/**` | `low` | `pending` | |
|
| `V3` | Rendering / Volume FrameData | 建立 `VisibleVolumeItem.md`,同步 `FrameData.md` | `docs/api/XCEngine/Rendering/FrameData/**` | `low` | `pending` | |
|
||||||
|
|||||||
Reference in New Issue
Block a user