xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix broken links in Math API docs

Browse Source 
Fix 30+ broken cross-references in docs/api/math/:
- viewport: viewport-getaspectratio/getrect -> getaspectratio/getrect
- matrix4: ../color/operator-mul -> operator_mul, operator-index -> operator_index
- matrix4/get-*: gettranslation/getscale/getrotation -> get-translation/-scale/-rotation
- vector3 operator links: operator_*_assign -> operator-*-assign
- vector3 operator links: operator_sub/add -> operator-sub/add
- vector3 operator-eq/neq: swap mutual references to use hyphen naming
- vector4: ../plane/constructor-default -> constructor_default
- Linter fixes: aabb and rectint relative paths corrected
This commit is contained in:
ssdfasd
2026-03-26 01:43:14 +08:00
parent d34d040563
commit 63d0271a5b
19 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/math/aabb/aabb.md
View File

@@ -43,5 +43,5 @@ OBB 是可以任意方向旋转的包围盒。
## 相关文档 ## 相关文档
- [Bounds](bounds/bounds.md) - 轴对齐包围盒 - [Bounds](../bounds/bounds.md) - 轴对齐包围盒
- [Math 模块总览](../math.md) - [Math 模块总览](../math.md)

6
docs/api/math/matrix4/decompose.md
View File

@@ -45,6 +45,6 @@ transform.Decompose(translation, rotation, scale);
- [Matrix4](matrix4.md) - 返回类总览 - [Matrix4](matrix4.md) - 返回类总览
- [TRS](trs.md) - 组合变换矩阵 - [TRS](trs.md) - 组合变换矩阵
- [GetTranslation](gettranslation.md) - 获取平移分量 - [GetTranslation](get-translation.md) - 获取平移分量
- [GetRotation](getrotation.md) - 获取旋转分量 - [GetRotation](get-rotation.md) - 获取旋转分量
- [GetScale](getscale.md) - 获取缩放分量 - [GetScale](get-scale.md) - 获取缩放分量

4
docs/api/math/matrix4/get-rotation.md
View File

@@ -37,6 +37,6 @@ Quaternion rotation = transform.GetRotation();
- [Matrix4](matrix4.md) - 返回类总览 - [Matrix4](matrix4.md) - 返回类总览
- [Quaternion](../quaternion/quaternion.md) - 四元数类 - [Quaternion](../quaternion/quaternion.md) - 四元数类
- [GetTranslation](gettranslation.md) - 获取平移分量 - [GetTranslation](get-translation.md) - 获取平移分量
- [GetScale](getscale.md) - 获取缩放分量 - [GetScale](get-scale.md) - 获取缩放分量
- [Decompose](decompose.md) - 分解矩阵 - [Decompose](decompose.md) - 分解矩阵

4
docs/api/math/matrix4/get-scale.md
View File

@@ -35,6 +35,6 @@ Vector3 scale = transform.GetScale();
## 相关文档 ## 相关文档
- [Matrix4](matrix4.md) - 返回类总览 - [Matrix4](matrix4.md) - 返回类总览
- [GetTranslation](gettranslation.md) - 获取平移分量 - [GetTranslation](get-translation.md) - 获取平移分量
- [GetRotation](getrotation.md) - 获取旋转分量 - [GetRotation](get-rotation.md) - 获取旋转分量
- [Decompose](decompose.md) - 分解矩阵 - [Decompose](decompose.md) - 分解矩阵

4
docs/api/math/matrix4/get-translation.md
View File

@@ -35,6 +35,6 @@ Vector3 translation = transform.GetTranslation();
## 相关文档 ## 相关文档
- [Matrix4](matrix4.md) - 返回类总览 - [Matrix4](matrix4.md) - 返回类总览
- [GetRotation](getrotation.md) - 获取旋转分量 - [GetRotation](get-rotation.md) - 获取旋转分量
- [GetScale](getscale.md) - 获取缩放分量 - [GetScale](get-scale.md) - 获取缩放分量
- [Decompose](decompose.md) - 分解矩阵 - [Decompose](decompose.md) - 分解矩阵

4
docs/api/math/matrix4/matrix4.md
View File

@@ -34,7 +34,7 @@
| [`RotationX`](rotationx.md) | 创建绕 X 轴旋转矩阵 | | [`RotationX`](rotationx.md) | 创建绕 X 轴旋转矩阵 |
| [`RotationY`](rotationy.md) | 创建绕 Y 轴旋转矩阵 | | [`RotationY`](rotationy.md) | 创建绕 Y 轴旋转矩阵 |
| [`RotationZ`](rotationz.md) | 创建绕 Z 轴旋转矩阵 | | [`RotationZ`](rotationz.md) | 创建绕 Z 轴旋转矩阵 |
| [`operator*`](operator-mul.md) | 矩阵乘法 | | [`operator*`](operator_mul.md) | 矩阵乘法 |
| [`MultiplyPoint`](multiplypoint.md) | 变换点（w=1） | | [`MultiplyPoint`](multiplypoint.md) | 变换点（w=1） |
| [`MultiplyVector`](multiplyvector.md) | 变换向量（w=0） | | [`MultiplyVector`](multiplyvector.md) | 变换向量（w=0） |
| [`Transpose`](transpose.md) | 转置矩阵 | | [`Transpose`](transpose.md) | 转置矩阵 |
@@ -44,7 +44,7 @@
| [`GetRotation`](get-rotation.md) | 获取旋转分量 | | [`GetRotation`](get-rotation.md) | 获取旋转分量 |
| [`GetScale`](get-scale.md) | 获取缩放分量 | | [`GetScale`](get-scale.md) | 获取缩放分量 |
| [`Decompose`](decompose.md) | 分解矩阵为变换分量 | | [`Decompose`](decompose.md) | 分解矩阵为变换分量 |
| [`operator[]`](operator-index.md) | 访问矩阵行数据 | | [`operator[]`](operator_index.md) | 访问矩阵行数据 |
## 使用示例 ## 使用示例

4
docs/api/math/rectint/rectint.md
View File

@@ -49,5 +49,5 @@ struct RectInt {
## 相关文档 ## 相关文档
- [Math 模块总览](../math.md) - 返回 Rect 模块总览 - [Math 模块总览](../math.md) - 返回 Rect 模块总览
- [Rect](rect-overview.md) - 浮点矩形版本 - [Rect](../rect/rect-overview.md) - 浮点矩形版本
- [Viewport](viewport.md) - 渲染视口 - [Viewport](../viewport/viewport.md) - 渲染视口

4
docs/api/math/vector3/operator-add-assign.md
View File

@@ -25,5 +25,5 @@ v += Vector3(4.0f, 5.0f, 6.0f); // v = (5.0f, 7.0f, 9.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator+`](operator_add.md) - 加法运算 - [`operator+`](operator-add.md) - 加法运算
- [`operator-=`](operator_sub_assign.md) - 减法赋值 - [`operator-=`](operator-sub-assign.md) - 减法赋值

4
docs/api/math/vector3/operator-add.md
View File

@@ -26,5 +26,5 @@ Vector3 c = a + b; // (5.0f, 7.0f, 9.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator-`](operator_sub.md) - 减法运算 - [`operator-`](operator-sub.md) - 减法运算
- [`operator+=`](operator_add_assign.md) - 加法赋值 - [`operator+=`](operator-add-assign.md) - 加法赋值

4
docs/api/math/vector3/operator-div-assign.md
View File

@@ -27,5 +27,5 @@ v /= 2.0f; // v = (3.0f, 4.0f, 5.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator/`](operator_div.md) - 除法运算 - [`operator/`](operator-div.md) - 除法运算
- [`operator*=`](operator_mul_assign.md) - 乘法赋值 - [`operator*=`](operator-mul-assign.md) - 乘法赋值

4
docs/api/math/vector3/operator-div.md
View File

@@ -36,5 +36,5 @@ Vector3 componentwise = a / b; // (3.0f, 4.0f, 5.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator*`](operator_mul.md) - 乘法运算 - [`operator*`](operator-mul.md) - 乘法运算
- [`operator/=`](operator_div_assign.md) - 除法赋值 - [`operator/=`](operator-div-assign.md) - 除法赋值

2
docs/api/math/vector3/operator-eq.md
View File

@@ -29,4 +29,4 @@ bool equal2 = (a == c); // true（因为差异在 EPSILON 内）
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator!=`](operator_neq.md) - 不等比较 - [`operator==`](operator-eq.md) - 相等比较

4
docs/api/math/vector3/operator-mul-assign.md
View File

@@ -25,5 +25,5 @@ v *= 2.0f; // v = (2.0f, 4.0f, 6.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator*`](operator_mul.md) - 乘法运算 - [`operator*`](operator-mul.md) - 乘法运算
- [`operator/=`](operator_div_assign.md) - 除法赋值 - [`operator/=`](operator-div-assign.md) - 除法赋值

4
docs/api/math/vector3/operator-mul.md
View File

@@ -34,6 +34,6 @@ Vector3 componentwise = a * b; // (2.0f, 6.0f, 12.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator/`](operator_div.md) - 除法运算 - [`operator/`](operator-div.md) - 除法运算
- [`operator*=`](operator_mul_assign.md) - 乘法赋值 - [`operator*=`](operator-mul-assign.md) - 乘法赋值
- [Quaternion * Vector3](quaternion-multiply.md) - 四元数旋转向量 - [Quaternion * Vector3](quaternion-multiply.md) - 四元数旋转向量

2
docs/api/math/vector3/operator-neq.md
View File

@@ -27,4 +27,4 @@ bool notEqual = (a != b); // true
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator==`](operator_eq.md) - 相等比较 - [`operator!=`](operator-neq.md) - 不等比较

4
docs/api/math/vector3/operator-sub-assign.md
View File

@@ -25,5 +25,5 @@ v -= Vector3(1.0f, 2.0f, 3.0f); // v = (4.0f, 5.0f, 6.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator-`](operator_sub.md) - 减法运算 - [`operator-`](operator-sub.md) - 减法运算
- [`operator+=`](operator_add_assign.md) - 加法赋值 - [`operator+=`](operator-add-assign.md) - 加法赋值

4
docs/api/math/vector3/operator-sub.md
View File

@@ -26,5 +26,5 @@ Vector3 c = a - b; // (4.0f, 5.0f, 6.0f)
## 相关文档 ## 相关文档
- [Vector3 类总览](vector3.md) - 返回类总览 - [Vector3 类总览](vector3.md) - 返回类总览
- [`operator+`](operator_add.md) - 加法运算 - [`operator+`](operator-add.md) - 加法运算
- [`operator-=`](operator_sub_assign.md) - 减法赋值 - [`operator-=`](operator-sub-assign.md) - 减法赋值

2
docs/api/math/vector4/vector4.md
View File

@@ -29,7 +29,7 @@ Vector4 是四维向量结构体，常用于：
| 方法 | 描述 | | 方法 | 描述 |
|------|------| |------|------|
| [`Vector4()`](constructor-default.md) | 默认构造函数，创建零向量 | | [`Vector4()`](constructor_default.md) | 默认构造函数，创建零向量 |
| [`Vector4(x, y, z, w)`](constructor.md) | 从四个分量构造向量 | | [`Vector4(x, y, z, w)`](constructor.md) | 从四个分量构造向量 |
| [`Vector4(Vector3, w)`](constructor-vector3.md) | 从 Vector3 构造（w 默认 0） | | [`Vector4(Vector3, w)`](constructor-vector3.md) | 从 Vector3 构造（w 默认 0） |
| [`Zero`](zero.md) | 返回零向量 (0, 0, 0, 0) | | [`Zero`](zero.md) | 返回零向量 (0, 0, 0, 0) |

8
docs/api/math/viewport/viewport.md
View File

@@ -35,11 +35,11 @@ struct Viewport {
| 方法 | 返回值 | 描述 | | 方法 | 返回值 | 描述 |
|------|--------|------| |------|--------|------|
| [GetAspectRatio()](viewport-getaspectratio.md) | `float` | 宽高比 (width / height) | | [GetAspectRatio()](getaspectratio.md) | `float` | 宽高比 (width / height) |
| [GetRect()](viewport-getrect.md) | `Rect` | 转换为 Rect | | [GetRect()](getrect.md) | `Rect` | 转换为 Rect |
## 相关文档 ## 相关文档
- [Math 模块总览](../math.md) - 返回 Math 模块总览 - [Math 模块总览](../math.md) - 返回 Math 模块总览
- [Rect](rect-overview.md) - 浮点矩形 - [Rect](../rect/rect-overview.md) - 浮点矩形
- [RectInt](rectint.md) - 整数矩形 - [RectInt](../rectint/rectint.md) - 整数矩形