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:
51
docs/api/core/smartptr/MakeRef.md
Normal file
51
docs/api/core/smartptr/MakeRef.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# SmartPtr::MakeRef
|
||||
|
||||
```cpp
|
||||
template<typename T, typename... Args>
|
||||
Ref<T> MakeRef(Args&&... args);
|
||||
```
|
||||
|
||||
创建共享指针的工厂函数。
|
||||
|
||||
**描述**
|
||||
|
||||
`MakeRef` 是创建 `Ref<T>` 的工厂函数,使用完美转发将参数传递给 `T` 的构造函数。相比直接使用 `std::make_shared`,代码更简洁。
|
||||
|
||||
**模板参数:**
|
||||
- `T` - 被创建对象的类型
|
||||
- `Args` - 构造函数的参数类型
|
||||
|
||||
**参数:**
|
||||
- `args` - 转发给 T 构造函数的参数
|
||||
|
||||
**返回:** `Ref<T>` - 新创建的共享指针
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/SmartPtr.h>
|
||||
|
||||
class MyClass {
|
||||
public:
|
||||
MyClass(int a, int b) : m_a(a), m_b(b) {}
|
||||
int GetSum() const { return m_a + m_b; }
|
||||
private:
|
||||
int m_a, m_b;
|
||||
};
|
||||
|
||||
// 创建共享指针
|
||||
Core::Ref<MyClass> ref = Core::MakeRef<MyClass>(10, 20);
|
||||
printf("Sum: %d\n", ref->GetSum());
|
||||
|
||||
// 使用 lambda
|
||||
Core::Ref<std::function<void()>> callback = Core::MakeRef<std::function<void()>>([]() {
|
||||
printf("Callback invoked!\n");
|
||||
});
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [SmartPtr 总览](smartptr.md) - 返回类总览
|
||||
- [Ref](Ref.md) - Ref 类型说明
|
||||
Reference in New Issue
Block a user