2.2 KiB
2.2 KiB
XCEngine API Documentation
命名空间: XCEngine
类型: index
描述: 指向 docs/api/XCEngine 与 docs/api/XCEditor 两棵 canonical API 文档树以及审计状态页的统一入口。
概述
docs/api 当前维护两组并行的 public API 文档：
docs/api/XCEngine/**- 对齐
engine/include/XCEngine/**
- 对齐
docs/api/XCEditor/**- 对齐
new_editor/include/XCEditor/**
- 对齐
除此之外，docs/api/XCEngine/Editor/** 仍然描述 editor/src/** 这组 source-backed 旧编辑器 API。它和 XCEditor 不是同一棵树，后者对应的是新编辑器 UI / shell / widgets public headers。
Canonical 入口
- XCEngine/XCEngine.md - 与
engine/include/XCEngine/**并行的引擎运行时 API 根目录 - XCEditor/XCEditor.md - 与
new_editor/include/XCEditor/**并行的新编辑器 public API 根目录 - _meta/rebuild-status.md - 当前覆盖率、断链检查和目录索引审计状态
文档根树
| 文档根 | Canonical 文档 | 对应源码目录 |
|---|---|---|
XCEngine |
XCEngine/XCEngine.md | engine/include/XCEngine/ |
XCEditor |
XCEditor/XCEditor.md | new_editor/include/XCEditor/ |
XCEditor 模块导航
| 模块 | Canonical 文档 | 对应源码目录 |
|---|---|---|
Collections |
XCEditor/Collections/Collections.md | new_editor/include/XCEditor/Collections/ |
Fields |
XCEditor/Fields/Fields.md | new_editor/include/XCEditor/Fields/ |
Foundation |
XCEditor/Foundation/Foundation.md | new_editor/include/XCEditor/Foundation/ |
Shell |
XCEditor/Shell/Shell.md | new_editor/include/XCEditor/Shell/ |
Widgets |
XCEditor/Widgets/Widgets.md | new_editor/include/XCEditor/Widgets/ |