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:
44
docs/api/containers/hashmap/iterator.md
Normal file
44
docs/api/containers/hashmap/iterator.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# HashMap::begin / end
|
||||
|
||||
```cpp
|
||||
Iterator begin();
|
||||
Iterator end();
|
||||
ConstIterator begin() const;
|
||||
ConstIterator end() const;
|
||||
```
|
||||
|
||||
获取哈希表的迭代器。迭代器遍历所有桶中的元素。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 返回指向第一个元素和末尾(最后一个元素之后)位置的迭代器。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
XCEngine::Containers::HashMap<int, const char*> map;
|
||||
map.Insert(1, "one");
|
||||
map.Insert(2, "two");
|
||||
map.Insert(3, "three");
|
||||
|
||||
for (auto it = map.begin(); it != map.end(); ++it) {
|
||||
std::cout << it->first << " -> " << it->second << std::endl;
|
||||
}
|
||||
// 输出顺序不确定,取决于哈希桶的内部布局
|
||||
|
||||
// 范围 for 循环(需要 C++20 或手动实现 begin/end)
|
||||
for (auto& [key, value] : map) {
|
||||
std::cout << key << " -> " << value << std::endl;
|
||||
}
|
||||
|
||||
// 常量迭代器
|
||||
for (auto it = map.cbegin(); it != map.cend(); ++it) {
|
||||
std::cout << it->first << " -> " << it->second << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [HashMap 总览](hashmap.md) - 返回类总览
|
||||
Reference in New Issue
Block a user