docs: remove redundant Debug umbrella page

This commit is contained in:
2026-03-26 17:27:30 +08:00
parent 7a814c724d
commit ec4edb2689
4 changed files with 32 additions and 54 deletions

View File

@@ -8,9 +8,10 @@
1. `docs/api/XCEngine/**` 必须与 `engine/include/XCEngine/**` 保持平行。
2. canonical API 文档只保留一套;迁移完成后必须删除旧目录与旧入口。
3. 每个 public header 对应一个独立文档目录,每个类型页都使用 `{TypeName}/{TypeName}.md`
3. 默认情况下,每个 public header 对应一个独立文档目录,每个类型页都使用 `{TypeName}/{TypeName}.md`
4. 方法页优先使用源码中的原始函数名;不要改成 kebab-case、全小写或其它再命名形式。
5. API 文档必须以源码、实现、测试和真实调用点为依据,禁止只根据名字猜测行为。
6. 对于只承担聚合包含职责的 umbrella header可以并入模块页说明不强制再建一个同名类型目录。
## Canonical 目录结构
@@ -60,6 +61,7 @@ docs/api/
- 每个 public header 对应一个独立文件夹。
- 文件夹名必须与 header stem 或主要类型名一致。
- 保留源码中的大小写,不做风格改写。
- 如果 header 只是模块聚合入口,不声明独立类型,可以直接并入模块页,不单独建文件夹。
示例:
@@ -122,6 +124,20 @@ docs/api/
- 把“设计意图”当成“当前实现行为”来写。
- 把测试里假设成立的场景,误写成通用保证。
## umbrella header 例外规则
以下情况通常应视为模块聚合头,而不是单独类型页:
- 头文件主要由一组 `#include` 组成。
- 不声明独立类、结构体、枚举或函数族。
- 名称与模块目录同名,单独建页会造成 `Debug/Debug.md` 这类重复入口。
处理方式:
- 在模块页中增加“聚合头文件”或“包含入口”小节。
- 使用 `**头文件**: \`...\`` 保留头文件覆盖记录。
- 不再额外创建 `{HeaderStem}/{HeaderStem}.md`
## 契约分层规则
文档必须明确区分下面三层信息: