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:
22
docs/api/math/h/pi.md
Normal file
22
docs/api/math/h/pi.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Math::PI
|
||||
|
||||
```cpp
|
||||
constexpr float PI = 3.14159265358979323846f;
|
||||
```
|
||||
|
||||
圆周率常量,精确到 float 能表示的最高精度。
|
||||
|
||||
**用途:** 用于三角函数计算、弧度角度转换、圆形/弧度相关计算。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Math/Math.h>
|
||||
|
||||
float circumference = 2.0f * Math::PI * radius;
|
||||
float area = Math::PI * radius * radius;
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Math 总览](h.md) - 返回 Math 概览
|
||||
Reference in New Issue
Block a user