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:
40
docs/api/debug/loglevel/loglevel.md
Normal file
40
docs/api/debug/loglevel/loglevel.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# LogLevel
|
||||
|
||||
**命名空间**: `XCEngine::Debug`
|
||||
|
||||
**类型**: `enum class`
|
||||
|
||||
**描述**: 日志级别枚举,定义日志的严重程度。
|
||||
|
||||
## 概述
|
||||
|
||||
`LogLevel` 枚举定义了从最详细到最严重的日志级别。`Logger` 根据设置的最小级别过滤日志。
|
||||
|
||||
## 枚举值
|
||||
|
||||
| 值 | 说明 | 数值 |
|
||||
|----|------|------|
|
||||
| `Verbose` | 详细调试信息 | 0 |
|
||||
| `Debug` | 调试信息 | 1 |
|
||||
| `Info` | 一般信息 | 2 |
|
||||
| `Warning` | 警告信息 | 3 |
|
||||
| `Error` | 错误信息 | 4 |
|
||||
| `Fatal` | 致命错误 | 5 |
|
||||
|
||||
## 辅助函数
|
||||
|
||||
| 函数 | 描述 |
|
||||
|------|------|
|
||||
| `const char* LogLevelToString(LogLevel level)` | [将日志级别转换为字符串](logleveltostring.md) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
Logger::Get().SetMinimumLevel(LogLevel::Warning);
|
||||
// 只有 Warning、Error、Fatal 级别的日志会被输出
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Debug 模块总览](../debug.md) - 返回模块总览
|
||||
- [Logger](../logger/logger.md) - 日志记录器
|
||||
28
docs/api/debug/loglevel/logleveltostring.md
Normal file
28
docs/api/debug/loglevel/logleveltostring.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# LogLevelToString
|
||||
|
||||
```cpp
|
||||
const char* LogLevelToString(LogLevel level)
|
||||
```
|
||||
|
||||
将 `LogLevel` 枚举值转换为可读字符串。
|
||||
|
||||
**参数:**
|
||||
- `level` - 日志级别
|
||||
|
||||
**返回:** 对应级别的字符串("VERBOSE", "DEBUG", "INFO", "WARNING", "ERROR", "FATAL")
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/LogLevel.h>
|
||||
|
||||
XCEngine::Debug::LogLevel level = XCEngine::Debug::LogLevel::Error;
|
||||
const char* str = XCEngine::Debug::LogLevelToString(level);
|
||||
// str == "Error"
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [LogLevel 总览](loglevel.md) - 返回类总览
|
||||
Reference in New Issue
Block a user