|
|
8df04c120f
|
docs: 更新 API 文档 - 多模块修复和完善
- audio: 更新 audio-system 方法文档
- components: 新增 audio-listener/audio-source 组件方法文档，新增 remove-component 方法
- core: 更新 filewriter, types 文档
- math: 更新 box 方法文档
- memory: 更新 proxy-allocator 文档
- resources: 更新 loader 和 texture 文档
- rhi: 更新 opengl 设备、shader、swap-chain 文档
- threading: 更新 mutex 和 task-system 文档
|
2026-03-26 01:58:45 +08:00 |
|
|
|
6af872e9eb
|
docs: fix Resources module API docs naming conventions and broken links
- Rename constructor/destructor files to follow template spec:
- ctor.md → constructor.md, dtor.md → destructor.md (audioclip)
- texture_constructor.md → constructor.md, texture_destructor.md → destructor.md (texture)
- material-loader-constructor.md → constructor.md, material-loader-destructor.md → destructor.md
- Create missing constructor/destructor docs:
- audio-loader: constructor.md, destructor.md
- texture-loader: constructor.md, destructor.md
- Fix broken links to ResourceManager:
- shader-loader/index.md
- material-loader/index.md
- Remove duplicate folders (keep hyphenated versions):
- Delete shaderloader/ (keep shader-loader/)
- Delete resourcepackage/ (keep resource-package/)
- Merge textureimportsettings/ into texture-import-settings/
- Rename audio-loader method files:
- canload.md → can-load.md
- getdefaultsettings.md → get-default-settings.md
- getsupportedextensions.md → get-supported-extensions.md
- Update overview pages with proper method links and constructor/destructor entries
|
2026-03-22 14:42:27 +08:00 |
|
|
|
ea756c0177
|
docs: update resources API docs
|
2026-03-20 02:35:35 +08:00 |
|
|
|
7e4c48d4f9
|
docs: Document stub/not-implemented methods in resources module
Fixed discrepancies between source code and documentation:
- AsyncLoader: Document Initialize() ignores workerThreadCount, Submit() doesn't do actual async loading, Update() is stub
- ResourceManager: Document UnloadUnused() and ReloadResource() are stubs
- ResourceCache: Document OnZeroRefCount() and Flush() are stubs
- ResourceDependencyGraph: Document TopologicalSort() returns empty (stub)
- ResourceFileSystem: Document GetResourceInfo() doesn't fill modifiedTime, EnumerateResources() is stub
- FileArchive: Document Enumerate() is stub
- ResourcePackageBuilder: Document AddDirectory() is stub
- ImportSettings: Document LoadFromJSON/SaveToJSON are stubs
- TextureImportSettings/MeshImportSettings: Document JSON methods are stubs
- TextureLoader/MeshLoader/MaterialLoader/ShaderLoader/AudioLoader: Document GetDefaultSettings() returns nullptr
- AudioLoader: Document ParseWAVData() is stub, Load() doesn't parse WAV headers
- ShaderLoader: Document DetectShaderType/ParseShaderSource are stubs
- MaterialLoader: Document ParseMaterialData() is stub
- Texture: Document Create() mipLevels=0 behavior, GenerateMipmaps() returns false
- Mesh: Document MeshLoader::Load() is example only
- IResourceLoader: Document GetDefaultSettings() returns nullptr for all loaders
|
2026-03-19 01:16:12 +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 |
|
