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/core/filewriter/Close.md
Normal file
38
docs/api/core/filewriter/Close.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# FileWriter::Close
|
||||
|
||||
```cpp
|
||||
void Close();
|
||||
```
|
||||
|
||||
关闭文件。
|
||||
|
||||
**描述**
|
||||
|
||||
关闭当前打开的文件。如果文件未打开,则什么都不做。析构函数会自动调用此方法。
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
FileWriter writer;
|
||||
|
||||
if (writer.Open("data.txt")) {
|
||||
writer.Write("Some data\n");
|
||||
writer.Flush();
|
||||
writer.Close();
|
||||
}
|
||||
|
||||
// 文件已关闭,可再次打开其他文件
|
||||
if (writer.Open("other.txt")) {
|
||||
writer.Write("New content\n");
|
||||
}
|
||||
// 析构时自动关闭
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileWriter 总览](filewriter.md) - 返回类总览
|
||||
- [Open](Open.md) - 打开文件
|
||||
Reference in New Issue
Block a user