diff --git a/docs/api/XCEngine/Editor/panels/XCUIDemoPanel/XCUIDemoPanel.md b/docs/api/XCEngine/Editor/panels/XCUIDemoPanel/XCUIDemoPanel.md deleted file mode 100644 index 64356573..00000000 --- a/docs/api/XCEngine/Editor/panels/XCUIDemoPanel/XCUIDemoPanel.md +++ /dev/null @@ -1,34 +0,0 @@ -# XCUIDemoPanel - -**命名空间**: `XCEngine::Editor` - -**类型**: `legacy panel note` - -**描述**: 已退役的 XCUI 过渡演示面板说明页。当前源码树中不再存在 `editor/src/panels/XCUIDemoPanel.h/.cpp`。 - -## 当前状态 - -`XCUIDemoPanel` 对应的 panel 实现已经从当前 editor 源树移除，因此这里不再把它描述成“仍在运行中的当前面板”。 - -## 历史角色 - -这个页面保留的原因，是它曾经承担过一段明确的过渡职责： - -- 在 editor 仍由 ImGui 承载主工作区时，给 XCUI draw data 提供一个演示入口 -- 通过 `ImGuiTransitionBackend` 把 `UIDrawData` 翻译为 ImGui `ImDrawList` -- 用于验证 XCUI 绘制命令与编辑器旧前端之间的桥接链路 - -## 当前替代关系 - -在当前源码布局里，这条旧链路已经被拆散并下沉到更明确的部件： - -- XCUI demo runtime 声明收口到 [XCUIDemoRuntime](../../XCUIBackend/XCUIDemoRuntime/XCUIDemoRuntime.md) -- 过渡渲染桥接逻辑收口到 [ImGuiTransitionBackend](../../XCUIBackend/ImGuiTransitionBackend/ImGuiTransitionBackend.md) -- 通用绘制命令模型仍由 [DrawData](../../../UI/DrawData/DrawData.md) 描述 - -## 相关文档 - -- [panels](../panels.md) -- [XCUIDemoRuntime](../../XCUIBackend/XCUIDemoRuntime/XCUIDemoRuntime.md) -- [ImGuiTransitionBackend](../../XCUIBackend/ImGuiTransitionBackend/ImGuiTransitionBackend.md) -- [DrawData](../../../UI/DrawData/DrawData.md) diff --git a/docs/api/_meta/rebuild-status.md b/docs/api/_meta/rebuild-status.md index 666ad583..fadabc86 100644 --- a/docs/api/_meta/rebuild-status.md +++ b/docs/api/_meta/rebuild-status.md @@ -1,13 +1,13 @@ # API 文档重构状态 -**生成时间**: `2026-04-10 00:00:52` +**生成时间**: `2026-04-10 00:07:30` **来源**: `docs/api/_tools/audit_api_docs.py` ## 摘要 -- Markdown 页面数（全部）: `3794` -- Markdown 页面数（canonical）: `3766` +- Markdown 页面数（全部）: `3793` +- Markdown 页面数（canonical）: `3765` - Public headers 数: `313` - Editor source headers 数: `144` - 有效头文件引用数（全部）: `313` @@ -76,8 +76,8 @@ | 字段 | 页面数 | |------|--------| -| `命名空间` | `2492` | -| `类型` | `2492` | -| `描述` | `551` | +| `命名空间` | `2491` | +| `类型` | `2491` | +| `描述` | `550` | | `头文件` | `1903` | | `源文件` | `520` | diff --git a/docs/used/API文档实时同步任务池_2026-04-03.md b/docs/used/API文档实时同步任务池_2026-04-03.md index 6815960c..48e6927d 100644 --- a/docs/used/API文档实时同步任务池_2026-04-03.md +++ b/docs/used/API文档实时同步任务池_2026-04-03.md @@ -17,22 +17,23 @@ ## 当前复核快照 -- 最近一次结构审计时间：`2026-04-07 01:26:32` +- 最近一次结构审计时间：`2026-04-10 00:07:30` - 审计命令：`python -B docs/api/_tools/audit_api_docs.py` - 当前结果： - - `Public headers: 304` - - `Editor source headers: 142` - - `Valid header refs (canonical): 304` + - `Public headers: 313` + - `Editor source headers: 144` + - `Valid header refs (canonical): 313` - `Invalid header refs: 0` - `Invalid source refs: 0` - - `Valid source refs (Editor canonical): 142` + - `Valid source refs (Editor canonical): 144` - `Broken .md links: 0` - `Missing directory index pages: 0` - `Stale canonical doc tokens: 0` - `Stale editor doc tokens: 0` - `Stale editor canonical pages: 0` + - `Editor high-risk single-page dirs: 0` -这说明当前 canonical public header 覆盖与全部 Editor source-backed API 都已恢复全绿；此前集中在 `engine/include/XCEngine/UI/**` 的缺口已经收口完成。 +这说明当前 canonical public header 覆盖与全部 Editor source-backed API 都已跟上重大重构后的最新头文件集；本轮新增的 `Volume`、`Selection/Volumetric Passes`、`UI/Widgets Helpers` 与 Editor helper/source-backed 页面已经全部收口完成。 ### 已复核、暂不新开任务的区域 @@ -769,8 +770,50 @@ - 已更新 `RenderMaterialResolve.md`，补齐 render queue tag 解析、legacy builtin pass fallback、skybox 纹理模式优先级和常量 payload 有效性边界。 - 抽查 `InputTypes`、`TaskSystem` 与 `D3D12ResourceView` 后，本轮未发现新的明确文档失配。 +## T26 API 文档目录重大重构回归波次（2026-04-09 / 2026-04-10） + +- 状态: `DONE` +- 认领人: `Codex` +- 优先级: `P0` +- 写入范围: + - `docs/api/XCEngine/Resources/Volume/**` + - `docs/api/XCEngine/Components/VolumeRendererComponent/**` + - `docs/api/XCEngine/Rendering/FrameData/**` + - `docs/api/XCEngine/Rendering/Passes/**` + - `docs/api/XCEngine/Rendering/Pipelines/BuiltinForwardPipeline/**` + - `docs/api/XCEngine/UI/Widgets/**` + - `docs/api/XCEngine/Editor/ComponentEditors/**` + - `docs/api/XCEngine/Editor/panels/**` + - `docs/api/XCEngine/Editor/Viewport/Passes/**` + - `docs/api/_meta/rebuild-status.md` +- 主要源码依据: + - `engine/include/XCEngine/Resources/Volume/VolumeField.h` + - `engine/include/XCEngine/Resources/Volume/VolumeFieldLoader.h` + - `engine/include/XCEngine/Components/VolumeRendererComponent.h` + - `engine/include/XCEngine/Rendering/FrameData/VisibleVolumeItem.h` + - `engine/include/XCEngine/Rendering/Passes/BuiltinSelectionMaskPass.h` + - `engine/include/XCEngine/Rendering/Passes/BuiltinSelectionOutlinePass.h` + - `engine/include/XCEngine/Rendering/Passes/BuiltinVolumetricPass.h` + - `engine/include/XCEngine/UI/Widgets/UIDragDropInteraction.h` + - `engine/include/XCEngine/UI/Widgets/UIScrollModel.h` + - `editor/src/ComponentEditors/VolumeRendererComponentEditor.h` + - `editor/src/panels/MaterialInspectorMaterialState.h` + - `editor/src/panels/MaterialInspectorMaterialStateIO.h` + - `editor/src/Viewport/Passes/SceneViewportSelectionOutlinePass.h` + - `editor/src/Viewport/Passes/SceneViewportSelectionOutlinePass.cpp` +- 已确认问题: + - 重大重构后，`Volume` 资源、体渲染组件、`visibleVolumes` 帧数据主链、selection mask / outline pass、UI widget helpers 与若干 Editor source-backed 页面尚未完全进入 canonical API 树。 + - `SceneViewportSelectionOutlinePass` 文档仍停留在旧的 object-id outline 口径，与当前 `BuiltinSelectionMaskPass + BuiltinSelectionOutlinePass` 的两段链路不符。 + - `XCUIDemoPanel` 历史页与若干旧交叉引用已不再对应当前源码树，需要从 active source-backed 叙事中清理。 +- 完成记录: + - 已补齐 `Volume.md`、`VolumeField.md`、`VolumeFieldLoader.md`、`VolumeRendererComponent.md`、`VisibleVolumeItem.md`、`BuiltinSelectionMaskPass.md`、`BuiltinSelectionOutlinePass.md`、`BuiltinVolumetricPass.md`、`UIDragDropInteraction.md`、`UIScrollModel.md`、`VolumeRendererComponentEditor.md`、`MaterialInspectorMaterialState.md`、`MaterialInspectorMaterialStateIO.md` 等缺页，并同步相关 overview 页面。 + - 已把 `RenderSceneData`、`RenderSceneExtractor`、`BuiltinForwardPipeline`、`Passes.md` 与 `SceneViewportSelectionOutlinePass/**` 对齐到当前真实调用链。 + - 已清理 `XCUIDemoPanel` 作为当前 source-backed 页面/调用链入口的残留口径。 + - 已重新运行 `python -B docs/api/_tools/audit_api_docs.py`，确认 `Public headers: 313`、`Editor source headers: 144`、`Valid header refs (canonical): 313`、`Valid source refs (Editor canonical): 144`、`Broken .md links: 0`、`Missing directory index pages: 0`、`Editor high-risk single-page dirs: 0`。 + ## 当前结论 -- 第三轮复核当前已确认 `25` 组失配；`T01` 到 `T25` 已全部完成。 -- 当前 `Public headers` 已达到 `304/304`，`Editor source headers` 已达到 `142/142`；结构层、Resources、RHI、Rendering、UI 和全部 Editor source-backed API 均为全绿状态。 +- 第三轮复核当前已确认 `26` 组失配；`T01` 到 `T26` 已全部完成。 +- 当前 `Public headers` 已达到 `313/313`，`Editor source headers` 已达到 `144/144`；结构层、Resources、RHI、Rendering、UI 和全部 Editor source-backed API 均为全绿状态。 +- `Volume`、selection / volumetric rendering、UI widget helpers、Editor material-authoring helpers 与 Scene View selection-outline 文档链路均已同步到当前源码主线。 - 后续如果 `docs/plan/` 再出现新的 API 相关计划，或工作树新增/改动 public header、Editor source header，应继续在此任务池追加新任务块，并在收口前重新运行 `python -B docs/api/_tools/audit_api_docs.py`。