docs(api): sync active and archived API entry docs
This commit is contained in:
55
AGENT.md
55
AGENT.md
@@ -20,9 +20,11 @@
|
||||
- [docs/plan/Library启动预热与运行时异步加载混合重构计划_2026-04-04.md](docs/plan/Library启动预热与运行时异步加载混合重构计划_2026-04-04.md)
|
||||
- [docs/plan/Library启动预热与运行时异步加载混合重构计划_进度更新_2026-04-04.md](docs/plan/Library启动预热与运行时异步加载混合重构计划_进度更新_2026-04-04.md)
|
||||
- [docs/plan/Editor架构说明.md](docs/plan/Editor架构说明.md)
|
||||
- [docs/plan/Renderer下一阶段_Unity风格Shader体系正式化计划_2026-04-06.md](docs/plan/Renderer下一阶段_Unity风格Shader体系正式化计划_2026-04-06.md)
|
||||
- [docs/plan/Unity风格模型导入与Model资产架构重构计划_2026-04-10.md](docs/plan/Unity风格模型导入与Model资产架构重构计划_2026-04-10.md)
|
||||
- [docs/plan/NanoVDB体积云加载阻塞与Runtime上传修复计划_2026-04-10.md](docs/plan/NanoVDB体积云加载阻塞与Runtime上传修复计划_2026-04-10.md)
|
||||
- [docs/plan/3DGS专用PLY导入器与GaussianSplat资源缓存正式化计划_2026-04-10.md](docs/plan/3DGS专用PLY导入器与GaussianSplat资源缓存正式化计划_2026-04-10.md)
|
||||
- [docs/plan/XCUI_NewEditor主线重建计划_2026-04-07.md](docs/plan/XCUI_NewEditor主线重建计划_2026-04-07.md)
|
||||
- [docs/plan/XCUI完整架构设计与执行计划.md](docs/plan/XCUI完整架构设计与执行计划.md)
|
||||
- [docs/plan/XCUI_Phase_Status_2026-04-05.md](docs/plan/XCUI_Phase_Status_2026-04-05.md)
|
||||
- [docs/plan/C#脚本模块下一阶段计划.md](docs/plan/C%23脚本模块下一阶段计划.md)
|
||||
- [tests/TEST_SPEC.md](tests/TEST_SPEC.md)
|
||||
- [tests/UI/TEST_SPEC.md](tests/UI/TEST_SPEC.md)
|
||||
@@ -30,22 +32,35 @@
|
||||
已归档但当前仍常用的背景文档:
|
||||
|
||||
- [Library资产导入与缓存系统收口计划(归档)](docs/used/Library资产导入与缓存系统收口计划_完成归档_2026-04-03.md)
|
||||
- [API 文档第三轮任务池(归档基线)](docs/used/API文档实时同步任务池_2026-04-03.md)
|
||||
- [XCUI Phase Status 2026-04-05(归档)](docs/used/XCUI_Phase_Status_2026-04-05.md)
|
||||
- [Shader与Material系统下一阶段计划(归档)](docs/used/Shader与Material系统下一阶段计划_完成归档_2026-04-04.md)
|
||||
- [Unity 风格 Shader 体系正式化计划(归档)](docs/used/Renderer下一阶段_Unity风格Shader体系正式化计划_完成归档_2026-04-07.md)
|
||||
- [Renderer 当前阶段正式收口(阶段归档)](docs/used/Renderer当前阶段正式收口计划_阶段归档_2026-04-10.md)
|
||||
- [NanoVDB 后续正式化(阶段归档)](docs/used/NanoVDB稀疏体积渲染后续正式化计划_阶段归档_2026-04-10.md)
|
||||
- [SceneViewport Overlay / Gizmo 重构计划(归档)](docs/used/SceneViewport_Overlay_Gizmo_Rework_Plan_完成归档_2026-04-04.md)
|
||||
- [Unity式 SceneView Gizmo 正式化方案(归档)](docs/used/Unity式SceneView_Gizmo系统完整审查与正式化重构方案_完成归档_2026-04-06.md)
|
||||
- [NanoVDB 第一阶段完成归档](docs/used/NanoVDB稀疏体积渲染正式集成计划_第一阶段完成归档_2026-04-09.md)
|
||||
|
||||
如果任务落在 API 文档:
|
||||
|
||||
1. 先检查 `docs/plan/` 下有没有日期更晚的 API 相关计划或归档;当前活跃任务池是 [docs/plan/API文档实时同步任务池_2026-04-03.md](docs/plan/API文档实时同步任务池_2026-04-03.md)。这份任务池目前已经推进到第三轮 `T01-T20` 全部完成,结构审计保持全绿,但开始新一轮前仍要先确认是否又追加了新任务块。
|
||||
2. 再看 [docs/api-skill.md](docs/api-skill.md)。
|
||||
3. 再看 `docs/api/_meta/rebuild-status.md`。
|
||||
4. 一次只认领一个任务块,先改状态为 `DOING`,只写自己任务块允许的范围。
|
||||
1. 先检查 `docs/plan/` 下最新的 API 相关计划或并行任务板。当前工作树里已经存在多份 2026-04-09 的活跃文件,例如:
|
||||
- [docs/plan/API文档目录重构计划_2026-04-09.md](docs/plan/API文档目录重构计划_2026-04-09.md)
|
||||
- [docs/plan/API文档目录结构重大重构并行任务板_2026-04-09.md](docs/plan/API文档目录结构重大重构并行任务板_2026-04-09.md)
|
||||
- [docs/plan/API文档目录结构第二轮重构计划_2026-04-09.md](docs/plan/API文档目录结构第二轮重构计划_2026-04-09.md)
|
||||
- [docs/plan/API文档目录结构第二轮并行任务板_2026-04-09.md](docs/plan/API文档目录结构第二轮并行任务板_2026-04-09.md)
|
||||
- [docs/plan/API文档目录结构重构并行任务板_2026-04-09_第二轮.md](docs/plan/API文档目录结构重构并行任务板_2026-04-09_第二轮.md)
|
||||
2. 如果这些活跃文件都不覆盖当前问题,再回看 [docs/used/API文档实时同步任务池_2026-04-03.md](docs/used/API文档实时同步任务池_2026-04-03.md) 作为最近一轮完成基线。
|
||||
3. 再看 [docs/api-skill.md](docs/api-skill.md)。
|
||||
4. 再看 `docs/api/_meta/rebuild-status.md`。
|
||||
5. 一次只认领一个任务块,先改状态为 `DOING`,只写自己任务块允许的范围。
|
||||
|
||||
## 2. 当前工程事实
|
||||
|
||||
- 顶层 `CMakeLists.txt` 当前纳入 `engine/`、`editor/`、`new_editor/`、`managed/`、`mvs/RenderDoc/` 和 `tests/`。
|
||||
- `engine/` 构建静态库 `XCEngine`;`editor/` 构建 `XCEditor`,但输出文件名仍是 `editor/bin/<Config>/XCEngine.exe`。
|
||||
- `new_editor/` 当前构建 `XCUIEditorLib`、`XCUIEditorHost`;启用 `XCENGINE_BUILD_XCUI_EDITOR_APP` 时会输出 `new_editor/bin/<Config>/XCUIEditor.exe`。
|
||||
- `editor/` 目前继续保留为当前正式编辑器、行为对照和视觉基线来源。
|
||||
- `new_editor/` 当前构建 `XCUIEditorLib`、`XCUIEditorHost`;启用 `XCENGINE_BUILD_XCUI_EDITOR_APP` 时会输出 `new_editor/bin/<Config>/XCUIEditor.exe`,并被视为未来正式编辑器主线,而不再只是临时 sandbox。
|
||||
- editor 默认把仓库内的 `project/` 识别为工程根目录,也支持 `--project <path>` 覆盖。
|
||||
- 当前工程真实使用 `Assets/ + .meta + Library/` 的项目布局;`project/Library/` 是当前 workflow 的一部分,不是可随手忽略的垃圾目录。
|
||||
- Mono 运行时与 editor 的脚本类发现都从 `<project>/Library/ScriptAssemblies/` 加载程序集。
|
||||
@@ -81,8 +96,13 @@
|
||||
- `ObjectId` 渲染与 editor picking
|
||||
- `BuiltinInfiniteGridPass`
|
||||
- `BuiltinObjectIdOutlinePass`
|
||||
- `directional shadow`
|
||||
- `skybox`
|
||||
- `CameraRenderRequest::postScenePasses`
|
||||
- `CameraRenderRequest::overlayPasses`
|
||||
- `post-process / final color` 当前处于正式化收口阶段,不再是纯预留接口。
|
||||
- `NanoVDB` 体积渲染已进入当前正式运行链路,但 Vulkan / OpenGL 的 rollout 和多后端能力边界仍在继续收口。
|
||||
- 当前资源与导入主线正在继续向 `Model` 资产架构与 `3DGS GaussianSplat` 资源链扩展,不要再把 `.obj/.fbx/.ply` 简化理解为“文件直读后立刻渲染”的旧 sample 流程。
|
||||
- 当前主线不是 render graph,而是 shader / material contract、builtin pass contract 和 renderer-owned feature contract。
|
||||
|
||||
### 3.3 Editor
|
||||
@@ -126,13 +146,13 @@
|
||||
|
||||
### 3.4 XCUI / New Editor
|
||||
|
||||
- `new_editor/` 是当前 `XCUI` editor sandbox 主线;旧 `editor/` 的整体替换仍处于延后状态,不要把 `XCUI` 计划误读成“已经整体替换现有 editor”。
|
||||
- `new_editor/` 是未来正式编辑器主线,不再只是 sandbox;旧 `editor/` 当前继续保留为正式编辑器、行为对照和视觉基线。
|
||||
- 当前宿主分层是:
|
||||
- `XCUIEditorLib`
|
||||
- `XCUIEditorHost`
|
||||
- `XCUIEditorApp`(可选应用壳)
|
||||
- 共享 UI core、runtime screen host 与 widget 基础能力主要沉淀在 `engine/include/XCEngine/UI/` 与 `engine/src/UI/`;`new_editor/` 负责 XCUI editor 壳、宿主与 widget sandbox。
|
||||
- XCUI / new_editor 的测试规范以 [tests/UI/TEST_SPEC.md](tests/UI/TEST_SPEC.md) 为准;根目录虽然有 `tests/NewEditor/`,但当前具体测试实现主要放在 `tests/UI/` 下。
|
||||
- 共享 UI core、runtime screen host 与 widget 基础能力主要沉淀在 `engine/include/XCEngine/UI/` 与 `engine/src/UI/`;`new_editor/` 负责 XCUI editor 壳、宿主与产品装配。
|
||||
- `tests/UI/` 是当前 XCUI `Core / Editor / Runtime` 三层的唯一正式基础层验证入口;`new_editor/` 不承担测试堆场职责。
|
||||
|
||||
### 3.5 Scripting
|
||||
|
||||
@@ -262,15 +282,21 @@
|
||||
|
||||
只要任务涉及 `docs/api/`:
|
||||
|
||||
1. 先检查 `docs/plan/` 下有没有更新日期更晚的 API 计划或归档。
|
||||
2. 以最新任务池和 [docs/api-skill.md](docs/api-skill.md) 为执行规范。
|
||||
3. 改完必须重新执行:
|
||||
1. 先读 `docs/plan/API文档目录*.md` 里日期最新的 API 计划 / 并行任务板。
|
||||
2. 再看 [docs/api-skill.md](docs/api-skill.md) 和 `docs/api/_meta/rebuild-status.md`。
|
||||
3. 如果活跃计划没有覆盖当前问题,再回看 [docs/used/API文档实时同步任务池_2026-04-03.md](docs/used/API文档实时同步任务池_2026-04-03.md) 作为最近一轮归档基线。
|
||||
4. 改完必须重新执行:
|
||||
|
||||
```powershell
|
||||
python -B docs/api/_tools/audit_api_docs.py
|
||||
```
|
||||
|
||||
如果审计没回绿,不算完成。
|
||||
当前审计口径已经同时覆盖:
|
||||
|
||||
- `engine/include/XCEngine/**`
|
||||
- `new_editor/include/XCEditor/**`
|
||||
- `editor/src/**`
|
||||
|
||||
## 5. 推荐构建与验证入口
|
||||
|
||||
@@ -321,9 +347,10 @@ ctest --test-dir build -C Debug --output-on-failure
|
||||
- 资源导入与工程布局:`engine/include/XCEngine/Core/Asset/`、`engine/src/Core/Asset/`、`editor/src/Managers/ProjectManager.cpp`、`project/Assets/`、`project/Library/`
|
||||
- Material / shader / artifact:`engine/include/XCEngine/Resources/Material/`、`engine/src/Resources/Material/`、`engine/include/XCEngine/Core/Asset/ArtifactFormats.h`、`tests/Resources/Material/`
|
||||
- Editor viewport / gizmo / picking:`editor/src/Viewport/`、`editor/src/panels/SceneViewPanel.cpp`、`tests/Editor/`
|
||||
- XCUI / new_editor:`engine/include/XCEngine/UI/`、`engine/src/UI/`、`new_editor/include/XCEditor/`、`new_editor/src/`、`tests/UI/`
|
||||
- Editor actions / project routing:`editor/src/Actions/`、`editor/src/Commands/`、`editor/src/Core/`、`editor/src/Managers/`、`tests/Editor/test_action_routing.cpp`
|
||||
- 脚本运行时与程序集:`engine/include/XCEngine/Scripting/`、`engine/src/Scripting/`、`managed/`、`project/Assets/Scripts/`、`tests/Scripting/`
|
||||
- API 文档:`docs/api/XCEngine/`、`docs/api/_guides/`、`docs/api/_tools/audit_api_docs.py`、`docs/plan/API文档实时同步任务池_2026-04-03.md`
|
||||
- API 文档:`docs/api/main.md`、`docs/api/XCEngine/`、`docs/api/XCEditor/`、`docs/api/_guides/`、`docs/api/_tools/audit_api_docs.py`、`docs/plan/API文档目录*.md`、`docs/used/API文档实时同步任务池_2026-04-03.md`
|
||||
|
||||
## 7. 适合当前仓库的工作方式
|
||||
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
# XCEngine API Documentation Skill
|
||||
# XCEngine / XCEditor API Documentation Skill
|
||||
|
||||
|
||||
## 目标
|
||||
|
||||
这份规范面向维护 `XCEngine` API 文档的 coding agent。它的目标不是“批量生成一套看起来完整的文档”,而是持续把当前源码、测试和真实调用链路同步到唯一的 canonical API 文档树里。
|
||||
这份规范面向维护 `XCEngine` / `XCEditor` API 文档的 coding agent。它的目标不是“批量生成一套看起来完整的文档”,而是持续把当前源码、测试和真实调用链路同步到当前活跃的 canonical API 文档树里。
|
||||
|
||||
当前仓库已经进入“增量同步”阶段。重点不再是补骨架,而是:
|
||||
|
||||
@@ -12,11 +13,14 @@
|
||||
|
||||
## 当前范围
|
||||
|
||||
API 文档的正式范围包含两部分:
|
||||
API 文档的正式范围包含三部分:
|
||||
|
||||
1. 引擎 public API
|
||||
- 对齐 `engine/include/XCEngine/**`
|
||||
2. Editor source-backed API
|
||||
2. 新 Editor public API
|
||||
- 对齐 `new_editor/include/XCEditor/**`
|
||||
- canonical 文档入口放在 `docs/api/XCEditor/**`
|
||||
3. Editor source-backed API
|
||||
- 对齐 `editor/src/**`
|
||||
- canonical 文档入口仍放在 `docs/api/XCEngine/Editor/**`
|
||||
|
||||
@@ -28,35 +32,46 @@ API 文档的正式范围包含两部分:
|
||||
- 审计结果、阶段性状态
|
||||
- `docs/api/_tools/**`
|
||||
- 审计、生成、修链脚本
|
||||
- `docs/plan/API文档实时同步任务池_2026-04-03.md`
|
||||
- 当前多任务并行同步池
|
||||
- `docs/plan/API文档目录*.md`
|
||||
- 当前活跃 API 计划、重构计划与并行任务板
|
||||
- `docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md`
|
||||
- 最近一轮 `XCEditor / Model / GaussianSplat` 收口记录
|
||||
- `docs/used/API文档实时同步任务池_2026-04-03.md`
|
||||
- 最近一轮已完成的归档基线
|
||||
- `README.md` / `editor/README.md` / `AGENT.md`
|
||||
- 这些不是 canonical API 页,但一旦它们引用 API 模块结构、测试目录或 Editor helper 分层,就属于必须同步的活跃协作文档
|
||||
|
||||
## 硬约束
|
||||
|
||||
1. `docs/api/XCEngine/**` 是唯一 canonical API 树。
|
||||
1. `docs/api/XCEngine/**` 与 `docs/api/XCEditor/**` 是当前两棵 canonical API 树;`docs/api/XCEngine/Editor/**` 继续承载 `editor/src/**` 的 source-backed 文档入口。
|
||||
2. 文档必须以“当前 header + 当前实现 + 当前测试 + 当前真实调用点”为依据,不能按旧文档或命名猜行为。
|
||||
3. 删除的 API 页面要一起删除,相关交叉链接也必须一起清理。
|
||||
4. 方法页优先使用源码中的原始函数名;不要擅自改成 kebab-case 或小写别名。
|
||||
5. 不要把“设计意图”写成“当前实现行为”。
|
||||
6. 不要为已经删除的 API 保留默认兼容入口页,除非任务明确要求。
|
||||
7. `rebuild-status.md` 以审计脚本输出为准;并发场景下,stdout 比旧文件内容更可信。
|
||||
8. 只收口活跃文档;`docs/plan/used/**`、`docs/used/**` 等归档材料默认保留历史写法,不要为了“顺手统一”去重写归档。
|
||||
8. 默认先收口活跃文档;只有当任务明确涉及归档链、入口路径或历史基线说明时,才修改 `docs/used/**`。
|
||||
9. Windows 工作树里的路径大小写按真实目录名写,例如 `tests/Editor/`、`tests/Core/`、`tests/Scripting/`,不要继续传播 `tests/editor/`、`tests/core/` 之类的历史噪音。
|
||||
|
||||
## 工作流
|
||||
|
||||
### 1. 开工前先看两份文件
|
||||
### 1. 开工前先看两类文件
|
||||
|
||||
- 任务池:
|
||||
- `docs/plan/API文档实时同步任务池_2026-04-03.md`
|
||||
- 最新活跃计划:
|
||||
- `docs/plan/API文档目录*.md`
|
||||
- `docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md`
|
||||
- 最新审计:
|
||||
- `docs/api/_meta/rebuild-status.md`
|
||||
|
||||
如果任务池和工作树不一致,以当前源码和重新执行审计后的结果为准。
|
||||
如果活跃计划和工作树不一致,以当前源码和重新执行审计后的结果为准。
|
||||
|
||||
如果 `docs/plan/` 下出现日期更晚的 API 相关计划或归档文件,优先读取更新日期更晚的文件,再判断当前任务池是否已经转入 `docs/plan/used/`。
|
||||
如果当前活跃计划没有覆盖你的问题,再回看:
|
||||
|
||||
- `docs/used/API文档实时同步任务池_2026-04-03.md`
|
||||
|
||||
作为最近一轮完成归档的基线。
|
||||
|
||||
如果 `docs/plan/` 下出现日期更晚的 API 相关计划,优先读取日期更晚的活跃文件;当前仓库里的归档根目录是 `docs/used/**`,不要再假设存在 `docs/plan/used/**`。
|
||||
|
||||
如果工作内容会改到 `README.md`、`editor/README.md` 或 `AGENT.md`:
|
||||
|
||||
@@ -121,10 +136,13 @@ python -B docs/api/_tools/audit_api_docs.py
|
||||
- `docs/api/main.md`
|
||||
- API 根页:
|
||||
- `docs/api/XCEngine/XCEngine.md`
|
||||
- `docs/api/XCEditor/XCEditor.md`
|
||||
- 模块页:
|
||||
- `docs/api/XCEngine/{ModuleName}/{ModuleName}.md`
|
||||
- `docs/api/XCEditor/{ModuleName}/{ModuleName}.md`
|
||||
- 子模块页:
|
||||
- `docs/api/XCEngine/{ModuleName}/{SubmoduleName}/{SubmoduleName}.md`
|
||||
- `docs/api/XCEditor/{ModuleName}/{SubmoduleName}/{SubmoduleName}.md`
|
||||
|
||||
示例:
|
||||
|
||||
@@ -132,6 +150,8 @@ python -B docs/api/_tools/audit_api_docs.py
|
||||
- `docs/api/XCEngine/Core/Asset/Asset.md`
|
||||
- `docs/api/XCEngine/Rendering/Passes/Passes.md`
|
||||
- `docs/api/XCEngine/Editor/Viewport/Viewport.md`
|
||||
- `docs/api/XCEditor/Foundation/Foundation.md`
|
||||
- `docs/api/XCEditor/Shell/Shell.md`
|
||||
|
||||
### 2. Header / source-backed 目录
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# API 文档重构状态
|
||||
|
||||
**生成时间**: `2026-04-10 17:24:02`
|
||||
**生成时间**: `2026-04-10 17:27:16`
|
||||
|
||||
**来源**: `docs/api/_tools/audit_api_docs.py`
|
||||
|
||||
|
||||
@@ -339,7 +339,7 @@
|
||||
- 这类问题与此前已收口的 `tests/Editor/` 一样,属于 Windows 工作树里最容易被忽略、但会持续制造噪音的路径口径漂移。
|
||||
- 完成记录:
|
||||
- 已把活跃 guide 与 canonical API 文档中的 `tests/Core/...`、`tests/Core/Math/...`、`tests/Scripting/...` 统一改成真实目录大小写。
|
||||
- 本轮只收口活跃文档;`docs/plan/used/`、`docs/used/` 等归档材料继续保留历史写法。
|
||||
- 本轮原始执行阶段只收口活跃文档;当前归档根统一位于 `docs/used/`。
|
||||
|
||||
## T11 Editor / Viewport 新增 header helper 补页
|
||||
|
||||
@@ -878,9 +878,34 @@
|
||||
- 已同步 `Resources.md`,把 `GaussianSplat` 纳入 `Resources` 模块子目录导航。
|
||||
- 已重新运行 `python -B docs/api/_tools/audit_api_docs.py`,确认 `Public headers: 384`、`Editor source headers: 144`、`Valid header refs (canonical): 384`、`Valid source refs (Editor canonical): 144`、`Invalid header refs: 0`、`Invalid source refs: 0`、`Broken .md links: 0`、`Missing directory index pages: 0`。
|
||||
|
||||
## T29 Rendering / `RenderMaterialResolve` 主页面内容回归(2026-04-10)
|
||||
|
||||
- 状态: `DONE`
|
||||
- 认领人: `Codex`
|
||||
- 优先级: `P1`
|
||||
- 写入范围:
|
||||
- `docs/api/XCEngine/Rendering/Materials/**`
|
||||
- `docs/plan/API文档目录结构第二轮并行任务板_2026-04-09.md`
|
||||
- `docs/api/_meta/rebuild-status.md`
|
||||
- 主要源码依据:
|
||||
- `engine/include/XCEngine/Rendering/Materials/RenderMaterialResolve.h`
|
||||
- `engine/include/XCEngine/Rendering/Builtin/BuiltinPassMetadataUtils.h`
|
||||
- `engine/src/Rendering/Extraction/RenderSceneUtility.cpp`
|
||||
- `engine/src/Rendering/Pipelines/BuiltinForwardPipeline.cpp`
|
||||
- `engine/src/Rendering/Passes/BuiltinDepthStylePassBaseResources.cpp`
|
||||
- 已确认问题:
|
||||
- `RenderMaterialResolve.md` 仍停留在旧的 `BuiltinForwardMaterialData` / legacy helper 口径,没有同步 `BuiltinDepthStyleMaterialConstants`、`MaterialBufferResourceView` 与 depth-style 常量 payload 这条新公开链路。
|
||||
- 页面还把 `MatchesBuiltinPass(...)` 描述成直接依赖旧材质提示,而当前真实实现已经把匹配规则委托给 `BuiltinPassMetadataUtils::ShaderPassMatchesBuiltinPass(...)`。
|
||||
- `Materials.md` 也没有把 structured/raw material buffer binding 视图解析与 depth-style payload 作为当前模块职责写出来。
|
||||
- 完成记录:
|
||||
- 已重写 `RenderMaterialResolve.md` 的主类型、公开能力、关键 helper 和实现边界,移除已不在头文件里的 `BuiltinForwardMaterialData` / legacy helper 描述,补齐 `BuiltinDepthStyleMaterialConstants`、`MaterialBufferResourceView`、`ResolveBuiltinDepthStyleMaterialConstantPayload(...)` 与 `TryResolveMaterialBufferResourceView(...)`。
|
||||
- 已同步 `Materials.md`,把 depth-style 常量 payload 与 material buffer 视图解析纳入当前模块职责。
|
||||
- 已更新第二轮任务板,把 `RR3` 标记为当前会话完成。
|
||||
- 已重新运行 `python -B docs/api/_tools/audit_api_docs.py`,确认 `Valid header refs (canonical): 384`、`Valid source refs (Editor canonical): 144`、`Broken .md links: 0`、`Missing directory index pages: 0`。
|
||||
|
||||
## 当前结论
|
||||
|
||||
- 第三轮复核当前已确认 `28` 组失配;`T01` 到 `T28` 已完成,其中 `T27` 收口了 Rendering 目录归位后的总览口径和审计路径,`T28` 补齐了 `Resources/Model` 与 `Resources/GaussianSplat` 的 canonical 入口。
|
||||
- 第三轮复核当前已确认 `29` 组失配;`T01` 到 `T29` 已完成,其中 `T27` 收口了 Rendering 目录归位后的总览口径和审计路径,`T28` 补齐了 `Resources/Model` 与 `Resources/GaussianSplat` 的 canonical 入口,`T29` 完成了 `RenderMaterialResolve` 内容回归。
|
||||
- 当前 `engine/include/XCEngine/**`、`new_editor/include/XCEditor/**` 与 `editor/src/**` 三条 canonical 审计主线都已经回到全绿:`Valid header refs (canonical) = 384`、`Valid source refs (Editor canonical) = 144`、`Broken .md links = 0`、`Missing directory index pages = 0`。
|
||||
- 本轮新增纳入审计口径的 `XCEditor`、`Resources/Model` 与 `Resources/GaussianSplat` 已经进入 canonical API 树,不再是遗留缺口;Rendering 目录错位、overview 口径漂移和 stale-token 路径也已同步收口。
|
||||
- 本轮新增纳入审计口径的 `XCEditor`、`Resources/Model` 与 `Resources/GaussianSplat` 已经进入 canonical API 树,不再是遗留缺口;Rendering 目录错位、overview 口径漂移、`RenderMaterialResolve` 主页面内容漂移和 stale-token 路径也已同步收口。
|
||||
- 后续如果 `docs/plan/` 再出现新的 API 相关计划,或工作树新增/改动 public header、Editor source header,应继续在此任务池追加新任务块,并在收口前重新运行 `python -B docs/api/_tools/audit_api_docs.py`。
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## 文档定位
|
||||
|
||||
这份任务池接替已归档的:
|
||||
这份任务池现已归档,接替的是更早一轮活跃计划:
|
||||
|
||||
- `docs/plan/used/API文档并行更新任务池_2026-04-02.md`
|
||||
- `docs/plan/API文档并行更新任务池_2026-04-02.md`
|
||||
|
||||
旧任务池解决的是:
|
||||
|
||||
@@ -198,7 +198,7 @@
|
||||
- 优先级: `P2`
|
||||
- 写入范围:
|
||||
- `docs/api/_meta/rebuild-status.md`
|
||||
- `docs/plan/API文档实时同步任务池_2026-04-03.md`
|
||||
- `docs/used/API文档实时同步任务池_2026-04-03.md`
|
||||
- 主要依据:
|
||||
- `T01-T04` 完成结果
|
||||
- 完成标准:
|
||||
@@ -343,7 +343,7 @@
|
||||
- `docs/api/XCEngine/Editor/Managers/Managers.md`
|
||||
- `docs/api/_tools/audit_api_docs.py`
|
||||
- 必要时 `docs/api/_meta/rebuild-status.md`
|
||||
- 必要时 `docs/plan/API文档实时同步任务池_2026-04-03.md`
|
||||
- 必要时 `docs/used/API文档实时同步任务池_2026-04-03.md`
|
||||
- 主要源码依据:
|
||||
- `editor/src/Core/EditorConsoleSink.h`
|
||||
- `editor/src/Core/EditorConsoleSink.cpp`
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## 文档定位
|
||||
|
||||
这份任务池接替已归档的第一轮计划:
|
||||
这份任务池现已归档,接替的是第一轮归档:
|
||||
|
||||
- `docs/plan/used/API文档实时同步任务池_2026-04-03_第一轮归档.md`
|
||||
- `docs/used/API文档实时同步任务池_2026-04-03_第一轮归档.md`
|
||||
|
||||
第一轮已经解决的重点是:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user