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:
38
docs/api/memory/pool-allocator/contains.md
Normal file
38
docs/api/memory/pool-allocator/contains.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# PoolAllocator::Contains
|
||||
|
||||
```cpp
|
||||
bool Contains(void* ptr) const;
|
||||
```
|
||||
|
||||
检查给定的指针是否属于此内存池的地址范围。由于池在构造时预分配连续内存,可通过指针地址区间判断所有权。此方法用于调试和内存验证。
|
||||
|
||||
**参数:**
|
||||
- `ptr` - 要检查的指针
|
||||
|
||||
**返回:** 指针属于此池返回 `true`,否则返回 `false`
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Memory/PoolAllocator.h>
|
||||
|
||||
PoolAllocator pool(sizeof(int), 100);
|
||||
|
||||
void* inside = pool.Allocate();
|
||||
void* outside = ::operator new(sizeof(int));
|
||||
|
||||
if (pool.Contains(inside)) {
|
||||
// inside 属于此内存池,可以安全 Free
|
||||
}
|
||||
|
||||
if (!pool.Contains(outside)) {
|
||||
// outside 不属于此池,不能调用 pool.Free()
|
||||
::operator delete(outside);
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [PoolAllocator 总览](pool-allocator.md) - 返回类总览
|
||||
Reference in New Issue
Block a user