xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
528 Commits 1 Branch 0 Tags
c47e871c5a4ce3ff88aad56bec8bb3d04ba2a8e2
Commit Graph

7 Commits

Author SHA1 Message Date
ssdfasd
5c3566774b docs: 更新 containers 和 threading 模块文档 
- containers: 更新 string 类的多个方法文档
- threading: 更新 mutex 和 task-group 方法文档
 2026-03-26 01:59:14 +08:00
ssdfasd
445876752c docs: 修复 containers 和 rhi 模块的头文件路径 
- containers: 修正 Containers.h, Array.h, String.h, HashMap.h 的路径为 Core/Containers/
- rhi: 修正 D3D12 和 OpenGL 后端文档路径
 2026-03-26 01:58:16 +08:00
ssdfasd
0c073db4e8 docs: update containers API docs 2026-03-20 02:35:01 +08:00
ssdfasd
5257f3d75c docs: Fix SKILL.md规范 violations - Remove ## 方法列表 and flatten ### sub-headers in ## 公共方法 2026-03-19 02:01:18 +08:00
ssdfasd
12ae6f561a docs: Fix containers module documentation discrepancies 
- Array::SetAllocator: Remove reference to non-existent PoolAllocator class
- HashMap::SetAllocator: Remove reference to non-existent GetDefaultAllocator()
- HashMap::Copy/Move: Fix move constructor complexity (O(m_bucketCount), not O(1))
- HashMap::iterator: Remove C++20 structured bindings example
- String: Add missing links for operator+ and operator==/!=
 2026-03-19 01:14:20 +08:00
ssdfasd
6a952473ce docs: fix threading module documentation discrepancies 
- Fix include paths: use #include "Threading/..." instead of <XCEngine/Threading/...>
- Document protected ITask constructors (ITask(), ITask(TaskPriority))
- Document Callback typedef in TaskGroup
- Clarify Mutex STL-compatible methods are const
- Note GetProgress() implementation limitation (returns 0.0f)
 2026-03-19 00:49:08 +08:00
ssdfasd
dc850d7739 docs: 重构 API 文档结构并修正源码准确性 
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
 2026-03-19 00:22:30 +08:00