|
|
f5a34f8adc
|
docs: 重构 API 文档 - components 和 scene 模块
- components: 修复英文标题为中文，添加缺失组件文档
- 新增 camera-component, light-component, audio-source-component, audio-listener-component 类总览
- 修复 get-position.md 格式
- 更新 components.md 模块总览
- scene: 修复方法文档格式，新增缺失方法
- 修复 find.md, create-game-object.md 英文标题
- 新增 FindByID, SerializeToString, DeserializeFromString 方法文档
- 更新 scene.md 类总览方法列表
|
2026-03-26 01:50:27 +08:00 |
|
|
|
63d0271a5b
|
Fix broken links in Math API docs
Fix 30+ broken cross-references in docs/api/math/:
- viewport: viewport-getaspectratio/getrect -> getaspectratio/getrect
- matrix4: ../color/operator-mul -> operator_mul, operator-index -> operator_index
- matrix4/get-*: gettranslation/getscale/getrotation -> get-translation/-scale/-rotation
- vector3 operator links: operator_*_assign -> operator-*-assign
- vector3 operator links: operator_sub/add -> operator-sub/add
- vector3 operator-eq/neq: swap mutual references to use hyphen naming
- vector4: ../plane/constructor-default -> constructor_default
- Linter fixes: aabb and rectint relative paths corrected
|
2026-03-26 01:43:14 +08:00 |
|
|
|
0f0ab8922a
|
docs: fix naming conventions across threading, math, memory, core, and debug modules
threading/:
- Rename 19 camelCase method files to hyphenated names
- task-system: createtaskgroup→create-task-group, etc.
- tasksystemconfig: enabletaskprofiling→enable-task-profiling, etc.
- thread: getcurrentid→get-current-id, etc.
- task: addref→add-ref, getid→get-id, etc.
math/:
- Rename underscore operator files to hyphenated
- vector3: operator_add→operator-add, etc.
- matrix4: gettranslation→get-translation, etc.
- vector4: tovector3→to-vector3, constructor_vector3→constructor-vector3
- sphere: sphere_constructor→sphere-constructor, etc.
memory/:
- Remove duplicate memorymanager/ folder (kept manager/ which was correct)
core/:
- filewriter: Consolidate ctor-default.md and ctor-file.md into constructor.md
- Rename dtor.md→destructor.md
debug/:
- filelogsink: Rename construct.md→constructor.md, ~filelogsink.md→destructor.md
All overview pages updated with new file references.
|
2026-03-22 23:09:29 +08:00 |
|
|
|
629455df07
|
Update API documentation and remove obsolete plan files
|
2026-03-21 15:55:04 +08:00 |
|
|
|
c5b17239ca
|
docs: update math API docs
|
2026-03-20 02:35:15 +08:00 |
|
|
|
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 |
|
