docs: update core and debug API docs

This commit is contained in:
2026-03-20 02:35:07 +08:00
parent 0c073db4e8
commit e165dbea1c
73 changed files with 743 additions and 391 deletions

View File

@@ -4,6 +4,8 @@
**类型**: `class`
**头文件**: `XCEngine/Core/RefCounted.h`
**描述**: 引用计数基类,提供线程安全的引用计数生命周期管理。
## 概述
@@ -14,28 +16,39 @@
| 方法 | 描述 |
|------|------|
| `RefCounted()` | 构造函数,初始引用计数为 1 |
| `virtual ~RefCounted()` | 虚析构函数 |
| [`AddRef`](AddRef.md) | 增加引用计数 |
| [`Release`](Release.md) | 减少引用计数(归零时自动 delete this |
| [`GetRefCount`](GetRefCount.md) | 获取当前引用计数 |
| [`RefCounted()`](refcounted.md) | 构造函数,初始引用计数为 1 |
| [`~RefCounted()`](refcounted.md) | 虚析构函数 |
| [`AddRef()`](AddRef.md) | 增加引用计数 |
| [`Release()`](Release.md) | 减少引用计数(归零时自动 delete this |
| [`GetRefCount()`](GetRefCount.md) | 获取当前引用计数 |
## 使用示例
```cpp
class MyObject : public RefCounted {
#include <XCEngine/Core/RefCounted.h>
#include <cstdio>
class MyObject : public XCEngine::Core::RefCounted {
public:
MyObject() { /* ... */ }
~MyObject() { /* ... */ }
MyObject() { }
virtual ~MyObject() { }
void DoSomething() { /* ... */ }
void DoSomething() { }
};
// 使用
MyObject* obj = new MyObject(); // refCount = 1
obj->AddRef(); // refCount = 2
obj->Release(); // refCount = 1
obj->Release(); // refCount = 0, 自动 delete
int main() {
MyObject* obj = new MyObject();
printf("After create: %u\n", obj->GetRefCount());
obj->AddRef();
printf("After AddRef: %u\n", obj->GetRefCount());
obj->Release();
printf("After Release: %u\n", obj->GetRefCount());
obj->Release();
return 0;
}
```
## 相关文档