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:
42
docs/api/core/filewriter/Flush.md
Normal file
42
docs/api/core/filewriter/Flush.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# FileWriter::Flush
|
||||
|
||||
```cpp
|
||||
bool Flush();
|
||||
```
|
||||
|
||||
刷新缓冲区。
|
||||
|
||||
**描述**
|
||||
|
||||
将缓冲区中的数据强制写入磁盘,确保数据持久化。在写入大量数据后应调用此方法以确保数据已保存。
|
||||
|
||||
**返回:** `bool` - 是否刷新成功
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
FileWriter writer("output.txt");
|
||||
if (writer.IsOpen()) {
|
||||
// 写入大量数据
|
||||
for (int i = 0; i < 1000; i++) {
|
||||
writer.Write("Line ");
|
||||
writer.Write(std::to_string(i).c_str());
|
||||
writer.Write("\n");
|
||||
}
|
||||
|
||||
// 刷新确保数据写入磁盘
|
||||
writer.Flush();
|
||||
|
||||
// 数据已安全保存
|
||||
writer.Close();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileWriter 总览](filewriter.md) - 返回类总览
|
||||
- [Write](Write.md) - 写入数据
|
||||
Reference in New Issue
Block a user