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 个断裂引用
This commit is contained in:
40
docs/api/core/smartptr/Ref.md
Normal file
40
docs/api/core/smartptr/Ref.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# SmartPtr::Ref
|
||||
|
||||
```cpp
|
||||
template<typename T>
|
||||
using Ref = std::shared_ptr<T>;
|
||||
```
|
||||
|
||||
共享引用智能指针类型别名。
|
||||
|
||||
**描述**
|
||||
|
||||
`Ref<T>` 是 `std::shared_ptr<T>` 的类型别名,提供共享所有权的智能指针。多个 `Ref` 可以指向同一个对象,通过引用计数管理生命周期。当最后一个 `Ref` 被销毁时,对象会被自动删除。
|
||||
|
||||
**模板参数:**
|
||||
- `T` - 被托管对象的类型
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/SmartPtr.h>
|
||||
|
||||
class MyClass {
|
||||
public:
|
||||
void DoSomething() { /* ... */ }
|
||||
};
|
||||
|
||||
Core::Ref<MyClass> ref1 = Core::MakeRef<MyClass>();
|
||||
Core::Ref<MyClass> ref2 = ref1; // 共享所有权
|
||||
|
||||
if (ref1) {
|
||||
ref1->DoSomething();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [SmartPtr 总览](smartptr.md) - 返回类总览
|
||||
- [MakeRef](MakeRef.md) - 创建 Ref 的工厂函数
|
||||
Reference in New Issue
Block a user