docs: Remove sub-headers from 公共方法 sections to follow SKILL.md规范

2026-03-19 01:59:38 +08:00
parent b46d450429
commit 8e85fd98b8
13 changed files with 3 additions and 314 deletions
--- a/docs/api/debug/logger/logger.md
+++ b/docs/api/debug/logger/logger.md
@@ -20,24 +20,12 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `void Initialize()` | [初始化日志系统](initialize.md) |
 | `void Shutdown()` | [关闭日志系统](shutdown.md) |
-
-### Sink 管理
-
-| 方法 | 描述 |
-|------|------|
 | `void AddSink(std::unique_ptr<ILogSink> sink)` | [添加日志输出目标](addsink.md) |
 | `void RemoveSink(ILogSink* sink)` | [移除日志输出目标](removesink.md) |
-
-### 日志记录
-
-| 方法 | 描述 |
-|------|------|
 | `void Log(...)` | [通用日志记录](log.md) |
 | `void Verbose(...)` | [Verbose 级别日志](verbose.md) |
 | `void Debug(...)` | [Debug 级别日志](debug.md) |
@@ -45,11 +33,6 @@
 | `void Warning(...)` | [Warning 级别日志](warning.md) |
 | `void Error(...)` | [Error 级别日志](error.md) |
 | `void Fatal(...)` | [Fatal 级别日志](fatal.md) |
-
-### 配置
-
-| 方法 | 描述 |
-|------|------|
 | `void SetMinimumLevel(...)` | [设置最小日志级别](setminimumlevel.md) |
 | `void SetCategoryEnabled(...)` | [开启/关闭指定分类](setcategoryenabled.md) |

--- a/docs/api/debug/profiler/profiler.md
+++ b/docs/api/debug/profiler/profiler.md
@@ -18,38 +18,16 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `void Initialize()` | [初始化性能分析器](initialize.md) |
 | `void Shutdown()` | [关闭性能分析器](shutdown.md) |
-
-### 性能测量
-
-| 方法 | 描述 |
-|------|------|
 | `void BeginProfile(const char* name)` | [开始一个性能分析块](beginprofile.md) |
 | `void EndProfile()` | [结束当前性能分析块](endprofile.md) |
-
-### 帧管理
-
-| 方法 | 描述 |
-|------|------|
 | `void BeginFrame()` | [开始一帧的分析](beginframe.md) |
 | `void EndFrame()` | [结束一帧的分析](endframe.md) |
-
-### 事件标记
-
-| 方法 | 描述 |
-|------|------|
 | `void MarkEvent(const char* name, uint64_t timestamp, uint32_t threadId)` | [标记一个事件点](markevent.md) |
 | `void SetMarker(const char* name, uint32_t color)` | [设置帧标记](setmarker.md) |
-
-### 导出
-
-| 方法 | 描述 |
-|------|------|
 | `void ExportChromeTracing(const Containers::String& filePath)` | [导出为 Chrome Tracing JSON 格式](exportchrometracing.md) |

 ## 宏定义
--- a/docs/api/math/transform/transform.md
+++ b/docs/api/math/transform/transform.md
@@ -28,17 +28,7 @@ struct Transform {
 |------|--------|------|
 | [ToMatrix()](tomatrix.md) | `Matrix4` | 转换为 4x4 变换矩阵 |
 | [Inverse()](inverse.md) | `Transform` | 逆变换 |
-
-### 运算符
-
-| 运算符 | 返回值 | 描述 |
-|--------|--------|------|
 | `operator*(Transform, Transform)` | `Transform` | 组合变换 |
-
-### 空间变换
-
-| 方法 | 返回值 | 描述 |
-|------|--------|------|
 | [TransformPoint(point)](transformpoint.md) | `Vector3` | 变换点（带平移） |
 | [TransformDirection(direction)](transformdirection.md) | `Vector3` | 变换方向（包含旋转和缩放） |
 | [InverseTransformPoint(point)](inversetransformpoint.md) | `Vector3` | 逆变换点 |
--- a/docs/api/memory/manager/manager.md
+++ b/docs/api/memory/manager/manager.md
@@ -18,31 +18,14 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `Initialize` | 初始化内存管理器 |
 | `Shutdown` | 关闭内存管理器 |
-
-### 系统分配器
-
-| 方法 | 描述 |
-|------|------|
 | `GetSystemAllocator` | 获取系统默认分配器 |
-
-### 分配器创建
-
-| 方法 | 描述 |
-|------|------|
 | `CreateLinearAllocator` | 创建线性分配器 |
 | `CreatePoolAllocator` | 创建内存池分配器 |
 | `CreateProxyAllocator` | 创建代理分配器 |
-
-### 内存管理
-
-| 方法 | 描述 |
-|------|------|
 | `SetTrackAllocations` | 设置是否跟踪分配 |
 | `DumpMemoryLeaks` | 输出内存泄漏报告 |
 | `GenerateMemoryReport` | 生成内存使用报告 |
--- a/docs/api/resources/asyncloader/asyncloader.md
+++ b/docs/api/resources/asyncloader/asyncloader.md
@@ -46,33 +46,16 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `void Initialize(Core::uint32 workerThreadCount = 2)` | 初始化异步加载器，创建工作线程 |
 | `void Shutdown()` | 关闭异步加载器，等待所有挂起任务完成 |
-
-### 提交请求
-
-| 方法 | 描述 |
-|------|------|
 | `void Submit(const Containers::String& path, ResourceType type, std::function<void(LoadResult)> callback)` | 提交异步加载请求 |
 | `void Submit(const Containers::String& path, ResourceType type, ImportSettings* settings, std::function<void(LoadResult)> callback)` | 带设置的异步加载请求 |
-
-### 进度查询
-
-| 方法 | 描述 |
-|------|------|
 | `void Update()` | 更新函数，在主线程调用，处理完成的加载请求 |
 | `bool IsLoading() const` | 是否有正在加载的资源 |
 | `Core::uint32 GetPendingCount() const` | 获取待处理加载请求数量 |
 | `float GetProgress() const` | 获取整体加载进度（0.0f ~ 1.0f） |
-
-### 取消操作
-
-| 方法 | 描述 |
-|------|------|
 | `void CancelAll()` | 取消所有待处理的加载请求 |
 | `void Cancel(Core::uint64 requestId)` | 取消指定 ID 的加载请求 |

--- a/docs/api/resources/dependencygraph/dependencygraph.md
+++ b/docs/api/resources/dependencygraph/dependencygraph.md
@@ -22,55 +22,28 @@

 ## 公共方法

-### 节点管理
-
 | 方法 | 描述 |
 |------|------|
 | `void AddNode(ResourceGUID guid, ResourceType type)` | 添加依赖节点 |
 | `void RemoveNode(ResourceGUID guid)` | 移除依赖节点 |
 | `bool HasNode(ResourceGUID guid) const` | 检查节点是否存在 |
-
-### 依赖关系
-
-| 方法 | 描述 |
-|------|------|
 | `void AddDependency(ResourceGUID owner, ResourceGUID dependency)` | 添加依赖关系（A 依赖 B） |
 | `void RemoveDependency(ResourceGUID owner, ResourceGUID dependency)` | 移除依赖关系 |
 | `Containers::Array<ResourceGUID> GetDependencies(ResourceGUID guid) const` | 获取指定资源的直接依赖列表 |
 | `Containers::Array<ResourceGUID> GetDependents(ResourceGUID guid) const` | 获取依赖指定资源的所有资源列表 |
 | `Containers::Array<ResourceGUID> GetAllDependencies(ResourceGUID guid) const` | 获取所有递归依赖（包括传递依赖） |
-
-### 引用计数
-
-| 方法 | 描述 |
-|------|------|
 | `void IncrementRefCount(ResourceGUID guid)` | 增加引用计数 |
 | `void DecrementRefCount(ResourceGUID guid)` | 减少引用计数 |
 | `Core::uint32 GetRefCount(ResourceGUID guid) const` | 获取引用计数 |
-
-### 循环检测
-
-| 方法 | 描述 |
-|------|------|
 | `bool HasCircularDependency(ResourceGUID guid, Containers::Array<ResourceGUID>& outCycle) const` | 检测是否存在循环依赖 |
-
-### 排序与卸载
-
-| 方法 | 描述 |
-|------|------|
 | `Containers::Array<ResourceGUID> TopologicalSort() const` | 拓扑排序（当前返回空数组 - stub） |
 | `bool Unload(ResourceGUID guid)` | 安全卸载（考虑依赖关系） |
+| `void Clear()` | 清空所有节点和依赖关系 |

 ## 实现说明

 **注意**: `TopologicalSort()` 当前为 stub，返回空数组。

-### 清理
-
-| 方法 | 描述 |
-|------|------|
-| `void Clear()` | 清空所有节点和依赖关系 |
-
 ## 使用示例

 ```cpp
--- a/docs/api/resources/filesystem/filesystem.md
+++ b/docs/api/resources/filesystem/filesystem.md
@@ -44,33 +44,16 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `void Initialize(const Containers::String& rootPath)` | 初始化，设置资源根目录 |
 | `void Shutdown()` | 关闭，释放所有归档 |
-
-### 归档和目录管理
-
-| 方法 | 描述 |
-|------|------|
 | `bool AddArchive(const Containers::String& archivePath)` | 添加归档包（优先查找） |
 | `bool AddDirectory(const Containers::String& directoryPath)` | 添加资源目录 |
 | `void RemoveArchive(const Containers::String& archivePath)` | 移除归档包 |
-
-### 资源查找
-
-| 方法 | 描述 |
-|------|------|
 | `bool FindResource(const Containers::String& relativePath, Containers::String& outAbsolutePath) const` | 查找资源的绝对路径 |
 | `bool Exists(const Containers::String& relativePath) const` | 检查资源是否存在 |
 | `Containers::Array<Core::uint8> ReadResource(const Containers::String& relativePath) const` | 读取资源文件内容（字节数组） |
-
-### 资源信息
-
-| 方法 | 描述 |
-|------|------|
 | `bool GetResourceInfo(const Containers::String& relativePath, ResourceInfo& outInfo) const` | 获取资源信息（部分字段可能未填充） |
 | `void EnumerateResources(const Containers::String& pattern, Containers::Array<ResourceInfo>& outResources) const` | 枚举匹配的资源（当前为 stub，仅清空输出） |

--- a/docs/api/resources/iresource/iresource.md
+++ b/docs/api/resources/iresource/iresource.md
@@ -12,8 +12,6 @@

 ## 公共方法

-### 基础属性
-
 | 方法 | 描述 |
 |------|------|
 | `ResourceType GetType() const` | 获取资源类型 |
@@ -22,32 +20,11 @@
 | `ResourceGUID GetGUID() const` | 获取全局唯一标识符 |
 | `bool IsValid() const` | 检查资源是否有效 |
 | `size_t GetMemorySize() const` | 获取资源占用的内存大小（字节） |
-
-### 生命周期
-
-| 方法 | 描述 |
-|------|------|
 | `void Release()` | 释放资源引用 |
-
-### 构造参数
-
-```cpp
-struct ConstructParams {
-    Containers::String name;      // 资源名称
-    Containers::String path;       // 资源路径
-    ResourceGUID guid;             // 全局唯一标识符
-    size_t memorySize = 0;         // 内存大小
-};
-```
-
-### 初始化方法
-
-| 方法 | 描述 |
-|------|------|
 | `void Initialize(const ConstructParams& params)` | 使用构造参数初始化资源 |
 | `void SetInvalid()` | 将资源标记为无效 |

-## 公共成员
+### 构造参数

 | 成员 | 类型 | 描述 |
 |------|------|------|
--- a/docs/api/resources/resourcecache/resourcecache.md
+++ b/docs/api/resources/resourcecache/resourcecache.md
@@ -32,26 +32,14 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `ResourceCache()` | 默认构造函数 |
 | `~ResourceCache()` | 析构函数 |
-
-### 缓存操作
-
-| 方法 | 描述 |
-|------|------|
 | `void Add(ResourceGUID guid, IResource* resource)` | 添加资源到缓存 |
 | `void Remove(ResourceGUID guid)` | 从缓存中移除资源 |
 | `IResource* Find(ResourceGUID guid) const` | 查找资源 |
 | `void Touch(ResourceGUID guid)` | 更新资源的访问时间（LRU） |
-
-### 内存管理
-
-| 方法 | 描述 |
-|------|------|
 | `size_t GetSize() const` | 获取缓存中资源数量 |
 | `size_t GetMemoryUsage() const` | 获取缓存内存使用量（字节） |
 | `void SetMemoryBudget(size_t bytes)` | 设置内存预算 |
@@ -60,11 +48,6 @@
 | `void OnZeroRefCount(ResourceGUID guid)` | 当引用计数为零时的回调（当前为空实现） |
 | `void Flush()` | 清空缓存，释放所有资源（当前为部分实现） |
 | `void Clear()` | 清空缓存但不释放资源 |
-
-### LRU 信息
-
-| 方法 | 描述 |
-|------|------|
 | `Containers::Array<ResourceGUID> GetLRUList(size_t count) const` | 获取最近最少使用的 GUID 列表 |

 ## 使用示例
--- a/docs/api/resources/resourcehandle/resourcehandle.md
+++ b/docs/api/resources/resourcehandle/resourcehandle.md
@@ -18,8 +18,6 @@

 ## 公共方法

-### 构造/析构
-
 | 方法 | 描述 |
 |------|------|
 | `ResourceHandle() = default` | 默认构造空句柄 |
@@ -27,40 +25,15 @@
 | `ResourceHandle(const ResourceHandle& other)` | 拷贝构造（自动增加引用） |
 | `ResourceHandle(ResourceHandle&& other) noexcept` | 移动构造 |
 | `~ResourceHandle()` | 析构函数（自动调用 Reset） |
-
-### 赋值
-
-| 方法 | 描述 |
-|------|------|
 | `ResourceHandle& operator=(const ResourceHandle& other)` | 拷贝赋值（自动管理引用） |
 | `ResourceHandle& operator=(ResourceHandle&& other) noexcept` | 移动赋值 |
-
-### 资源访问
-
-| 方法 | 描述 |
-|------|------|
 | `T* Get() const` | 获取裸指针 |
 | `T* operator->() const` | 通过指针访问资源成员 |
 | `T& operator*() const` | 解引用获取资源引用 |
-
-### 状态查询
-
-| 方法 | 描述 |
-|------|------|
 | `bool IsValid() const` | 检查句柄是否持有有效资源 |
 | `explicit operator bool() const` | 隐式布尔转换 |
-
-### GUID 和类型
-
-| 方法 | 描述 |
-|------|------|
 | `ResourceGUID GetGUID() const` | 获取资源的全局唯一标识符 |
 | `ResourceType GetResourceType() const` | 获取资源类型 |
-
-### 资源释放
-
-| 方法 | 描述 |
-|------|------|
 | `void Reset()` | 释放当前资源引用 |
 | `void Swap(ResourceHandle& other)` | 交换两个句柄的内容 |

--- a/docs/api/resources/resourcemanager/resourcemanager.md
+++ b/docs/api/resources/resourcemanager/resourcemanager.md
@@ -18,102 +18,39 @@

 ## 公共方法

-### 生命周期
-
 | 方法 | 描述 |
 |------|------|
 | `void Initialize()` | 初始化资源管理器 |
 | `void Shutdown()` | 关闭资源管理器，卸载所有资源 |
-
-### 资源根目录
-
-| 方法 | 描述 |
-|------|------|
 | `void SetResourceRoot(const Containers::String& rootPath)` | 设置资源根目录 |
 | `const Containers::String& GetResourceRoot() const` | 获取资源根目录 |
-
-### 同步加载
-
-| 方法 | 描述 |
-|------|------|
 | `ResourceHandle<T> Load(const Containers::String& path, ImportSettings* settings = nullptr)` | 同步加载资源（模板方法） |
-
-### 异步加载
-
-| 方法 | 描述 |
-|------|------|
 | `void LoadAsync(const Containers::String& path, ResourceType type, std::function<void(LoadResult)> callback)` | 异步加载资源 |
 | `void LoadAsync(const Containers::String& path, ResourceType type, ImportSettings* settings, std::function<void(LoadResult)> callback)` | 带设置的异步加载 |
-
-### 批量加载
-
-| 方法 | 描述 |
-|------|------|
 | `void LoadGroup(const Containers::Array<Containers::String>& paths, std::function<void(ResourceHandle<T>)> callback)` | 批量异步加载同类资源 |
-
-### 卸载管理
-
-| 方法 | 描述 |
-|------|------|
 | `void Unload(const Containers::String& path)` | 按路径卸载资源 |
 | `void Unload(ResourceGUID guid)` | 按 GUID 卸载资源 |
 | `void UnloadUnused()` | 卸载所有无引用的资源 |
 | `void UnloadAll()` | 卸载所有资源 |
-
-## 实现说明
-
-**注意**: 以下方法当前为部分实现或 stub 状态：
- `UnloadUnused()` 为空实现
- `ReloadResource()` 为 stub
-
-### 引用计数
-
-| 方法 | 描述 |
-|------|------|
 | `void AddRef(ResourceGUID guid)` | 增加引用计数（内部使用） |
 | `void Release(ResourceGUID guid)` | 减少引用计数（内部使用） |
 | `Core::uint32 GetRefCount(ResourceGUID guid) const` | 获取引用计数 |
-
-### 查找
-
-| 方法 | 描述 |
-|------|------|
 | `IResource* Find(const Containers::String& path)` | 按路径查找资源 |
 | `IResource* Find(ResourceGUID guid)` | 按 GUID 查找资源 |
 | `bool Exists(const Containers::String& path) const` | 检查资源是否存在 |
 | `bool Exists(ResourceGUID guid) const` | 检查 GUID 对应资源是否存在 |
-
-### 加载器管理
-
-| 方法 | 描述 |
-|------|------|
 | `void RegisterLoader(IResourceLoader* loader)` | 注册资源加载器 |
 | `void UnregisterLoader(ResourceType type)` | 注销加载器 |
 | `IResourceLoader* GetLoader(ResourceType type) const` | 获取指定类型的加载器 |
-
-### 内存管理
-
-| 方法 | 描述 |
-|------|------|
 | `void SetMemoryBudget(size_t bytes)` | 设置内存预算 |
 | `size_t GetMemoryUsage() const` | 获取当前内存使用量 |
 | `size_t GetMemoryBudget() const` | 获取内存预算 |
 | `void FlushCache()` | 清空缓存 |
-
-### 路径解析
-
-| 方法 | 描述 |
-|------|------|
 | `Containers::String ResolvePath(const Containers::String& relativePath) const` | 将相对路径解析为绝对路径 |
-
-### 资源信息
-
-| 方法 | 描述 |
-|------|------|
 | `Containers::Array<Containers::String> GetResourcePaths() const` | 获取所有已加载资源的路径列表 |
 | `void UnloadGroup(const Containers::Array<ResourceGUID>& guids)` | 按 GUID 批量卸载 |

-## 使用示例
+## 实现说明

 ```cpp
 // 初始化
--- a/docs/api/rhi/enums/enums.md
+++ b/docs/api/rhi/enums/enums.md
@@ -8,17 +8,10 @@

 ## 主要枚举

-### 着色器
-
 | 枚举 | 描述 |
 |------|------|
 | `ShaderType` | 着色器类型 |
 | `ShaderVisibility` | 着色器可见性 |
-
-### 渲染状态
-
-| 枚举 | 描述 |
-|------|------|
 | `CullMode` | 背面剔除模式 |
 | `FillMode` | 填充模式 |
 | `BlendOp` | 混合操作 |
@@ -26,48 +19,23 @@
 | `ComparisonFunc` | 比较函数 |
 | `StencilOp` | 模板操作 |
 | `PrimitiveTopology` | 图元拓扑 |
-
-### 纹理和采样
-
-| 枚举 | 描述 |
-|------|------|
 | `TextureType` | 纹理类型 |
 | `Format` | 纹理/缓冲区格式 |
 | `FilterMode` | 采样器过滤模式 |
 | `TextureAddressMode` | 纹理寻址模式 |
 | `BorderColor` | 边框颜色 |
-
-### 资源和缓冲
-
-| 枚举 | 描述 |
-|------|------|
 | `BufferType` | 缓冲区类型 |
 | `ResourceStates` | 资源状态 |
 | `HeapType` | 内存堆类型 |
 | `DescriptorType` | 描述符类型 |
 | `DescriptorHeapType` | 描述符堆类型 |
-
-### 命令和管线
-
-| 枚举 | 描述 |
-|------|------|
 | `CommandQueueType` | 命令队列类型 |
 | `PipelineType` | 管线类型 |
 | `LoadAction` | 加载操作 |
 | `StoreAction` | 存储操作 |
 | `PresentFlags` | 呈现标志 |
-
-### 查询和同步
-
-| 枚举 | 描述 |
-|------|------|
 | `QueryType` | 查询类型 |
 | `RootParameterType` | 根参数类型 |
-
-### 其他
-
-| 枚举 | 描述 |
-|------|------|
 | `LogicOp` | 逻辑操作 |
 | `ColorWriteMask` | 颜色写入掩码 |
 | `RHIType` | RHI 后端类型 |
--- a/docs/api/threading/task-group/task-group.md
+++ b/docs/api/threading/task-group/task-group.md
@@ -20,37 +20,15 @@

 ## 公共方法

-### 构造/析构
-
 | 方法 | 描述 |
 |------|------|
 | `TaskGroup()` | 默认构造函数 |
 | `~TaskGroup()` | 析构函数 |
-
-### 任务添加
-
-| 方法 | 描述 |
-|------|------|
 | [`AddTask(unique_ptr)`](addtask.md) | 添加任务对象 |
 | [`AddTask(callback)`](addtask.md) | 添加 lambda 任务 |
-
-### 依赖管理
-
-| 方法 | 描述 |
-|------|------|
 | [`AddDependency`](adddependency.md) | 添加任务依赖关系 |
-
-### 等待
-
-| 方法 | 描述 |
-|------|------|
 | [`Wait`](wait.md) | 阻塞等待所有任务完成 |
 | [`WaitFor`](waitfor.md) | 超时等待 |
-
-### 回调和状态
-
-| 方法 | 描述 |
-|------|------|
 | [`SetCompleteCallback`](setcompletecallback.md) | 设置完成回调 |
 | [`IsComplete`](iscomplete.md) | 检查所有任务是否完成 |
 | [`GetProgress`](getprogress.md) | 获取完成进度（0.0f ~ 1.0f） |