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:
51
docs/api/core/filewriter/Open.md
Normal file
51
docs/api/core/filewriter/Open.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# FileWriter::Open
|
||||
|
||||
```cpp
|
||||
bool Open(const char* filePath, bool append = false);
|
||||
```
|
||||
|
||||
打开文件。
|
||||
|
||||
**描述**
|
||||
|
||||
打开指定路径的文件,准备写入。如果之前已打开文件,会先关闭。返回是否成功打开文件。
|
||||
|
||||
**参数:**
|
||||
- `filePath` - 要打开的文件路径
|
||||
- `append` - 是否以追加模式打开,默认为覆盖模式
|
||||
|
||||
**返回:** `bool` - 是否成功打开
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Core/FileWriter.h>
|
||||
|
||||
FileWriter writer;
|
||||
|
||||
// 打开文件(覆盖模式)
|
||||
if (writer.Open("output.txt")) {
|
||||
writer.Write("Hello\n");
|
||||
writer.Close();
|
||||
}
|
||||
|
||||
// 打开文件(追加模式)
|
||||
if (writer.Open("log.txt", true)) {
|
||||
writer.Write("Another line\n");
|
||||
writer.Flush();
|
||||
}
|
||||
|
||||
// 检查是否成功
|
||||
FileWriter writer2;
|
||||
if (!writer2.Open("/invalid/path/file.txt")) {
|
||||
printf("Failed to open file\n");
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileWriter 总览](filewriter.md) - 返回类总览
|
||||
- [Close](Close.md) - 关闭文件
|
||||
- [IsOpen](IsOpen.md) - 检查文件状态
|
||||
Reference in New Issue
Block a user