docs(api): sync active and archived API entry docs
This commit is contained in:
@@ -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