From 553034da9e7616d03be5f5c10f78061f870ae28a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 13 Sep 2020 16:12:09 +0200 Subject: [PATCH] Math: doc++ --- src/Magnum/Math/Matrix3.h | 10 ++++++---- src/Magnum/Math/Matrix4.h | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/Magnum/Math/Matrix3.h b/src/Magnum/Math/Matrix3.h index ad55716a5..e299a4d7b 100644 --- a/src/Magnum/Math/Matrix3.h +++ b/src/Magnum/Math/Matrix3.h @@ -243,8 +243,9 @@ template class Matrix3: public Matrix3x3 { /** * @brief Check whether the matrix represents a rigid transformation * - * Rigid transformation consists only of rotation and translation (i.e. - * no scaling or projection). + * A [rigid transformation](https://en.wikipedia.org/wiki/Rigid_transformation) + * consists only of rotation, reflection and translation (i.e., no + * scaling, skew or projection). * @see @ref isOrthogonal() */ bool isRigidTransformation() const { @@ -598,8 +599,9 @@ template class Matrix3: public Matrix3x3 { /** * @brief Inverted rigid transformation matrix * - * Expects that the matrix represents rigid transformation. - * Significantly faster than the general algorithm in @ref inverted(). @f[ + * Expects that the matrix represents a [rigid transformation](https://en.wikipedia.org/wiki/Rigid_transformation) + * (i.e., no scaling, skew or projection). Significantly faster than + * the general algorithm in @ref inverted(). @f[ * A^{-1} = \begin{pmatrix} (A^{2,2})^T & (A^{2,2})^T \begin{pmatrix} a_{2,0} \\ a_{2,1} \end{pmatrix} \\ \begin{array}{cc} 0 & 0 \end{array} & 1 \end{pmatrix} * @f] * @f$ A^{i, j} @f$ is matrix without i-th row and j-th column, see diff --git a/src/Magnum/Math/Matrix4.h b/src/Magnum/Math/Matrix4.h index 41190f32e..ca3c5145e 100644 --- a/src/Magnum/Math/Matrix4.h +++ b/src/Magnum/Math/Matrix4.h @@ -477,8 +477,9 @@ template class Matrix4: public Matrix4x4 { /** * @brief Check whether the matrix represents a rigid transformation * - * Rigid transformation consists only of rotation and translation (i.e. - * no scaling or projection). + * A [rigid transformation](https://en.wikipedia.org/wiki/Rigid_transformation) + * consists only of rotation, reflection and translation (i.e., no + * scaling, skew or projection). * @see @ref isOrthogonal() */ bool isRigidTransformation() const { @@ -906,8 +907,9 @@ template class Matrix4: public Matrix4x4 { /** * @brief Inverted rigid transformation matrix * - * Expects that the matrix represents rigid transformation. - * Significantly faster than the general algorithm in @ref inverted(). @f[ + * Expects that the matrix represents a [rigid transformation](https://en.wikipedia.org/wiki/Rigid_transformation) + * (i.e., no scaling, skew or projection). Significantly faster than + * the general algorithm in @ref inverted(). @f[ * A^{-1} = \begin{pmatrix} (A^{3,3})^T & (A^{3,3})^T \begin{pmatrix} a_{3,0} \\ a_{3,1} \\ a_{3,2} \\ \end{pmatrix} \\ \begin{array}{ccc} 0 & 0 & 0 \end{array} & 1 \end{pmatrix} * @f] * @f$ A^{i, j} @f$ is matrix without i-th row and j-th column, see