docs(api): add gaussian splat pages and fix doc generators
This commit is contained in:
38
docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md
Normal file
38
docs/plan/API文档目录结构阶段进度_XCEditor与Model收口_2026-04-10.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# API 文档目录结构阶段进度:XCEditor 与 Model 收口
|
||||
|
||||
## 本阶段范围
|
||||
|
||||
- 新建 `docs/api/XCEditor/**` canonical 目录树,并生成 `new_editor/include/XCEditor/**` 对应的 header 总览页与方法页。
|
||||
- 新建 `docs/api/XCEngine/Resources/Model/Model.md` 模块索引,并生成 `Model` / `ModelArtifactIO` / `ModelLoader` / `AssimpModelImporter` 对应页面。
|
||||
- 处理并发新增的 `docs/api/XCEngine/Resources/GaussianSplat/**`,补齐模块索引与 `GaussianSplat` / `GaussianSplatArtifactIO` / `GaussianSplatLoader` 页面。
|
||||
- 修正目录脚手架与 canonical 生成器的两个问题:
|
||||
- 根索引页错误把 `XCEditor` 当成普通子目录,生成了失效的 `../api.md` 链接。
|
||||
- 窄范围生成 `Resources/Model` 时,头文件引用缺少 `XCEngine/` 前缀。
|
||||
|
||||
## 当前结果
|
||||
|
||||
执行时间:`2026-04-10`
|
||||
|
||||
审计命令:
|
||||
|
||||
```powershell
|
||||
python -B docs/api/_tools/audit_api_docs.py
|
||||
```
|
||||
|
||||
审计结果:
|
||||
|
||||
- `Public headers: 381`
|
||||
- `Valid header refs (canonical): 381`
|
||||
- `Invalid header refs: 0`
|
||||
- `Editor source headers: 144`
|
||||
- `Valid source refs (Editor canonical): 144`
|
||||
- `Invalid source refs: 0`
|
||||
- `Broken .md links: 0`
|
||||
- `Missing directory index pages: 0`
|
||||
|
||||
## 并行协作说明
|
||||
|
||||
- `docs/api/XCEditor/**` 本轮已经落成,不再作为待认领空树任务。
|
||||
- `docs/api/XCEngine/Resources/Model/**` 本轮已经补齐目录索引与 header 页面,不再重复认领。
|
||||
- `docs/api/XCEngine/Resources/GaussianSplat/**` 也已补齐,如头文件继续扩展,请直接在现有树上增量同步。
|
||||
- 后续如果 `new_editor/include/XCEditor/**` 或 `engine/include/XCEngine/Resources/Model/**` 再发生结构变动,应直接基于当前树增量同步,不要回退到“先补目录骨架”的阶段。
|
||||
Reference in New Issue
Block a user