From e94a596a8066012de4b6124207e8d9a1bf471a8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 19 Feb 2013 20:45:44 +0100 Subject: [PATCH] Math: code cleanup, doc++ --- src/Math/DualQuaternion.h | 3 ++- src/Math/Matrix3.h | 5 ++--- src/Math/Matrix4.h | 7 +++---- src/Math/Quaternion.h | 11 ++++++----- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/Math/DualQuaternion.h b/src/Math/DualQuaternion.h index 88f55582e..5302ab46f 100644 --- a/src/Math/DualQuaternion.h +++ b/src/Math/DualQuaternion.h @@ -29,7 +29,8 @@ namespace Magnum { namespace Math { @brief %Dual quaternion @tparam T Underlying data type -@see Dual, Quaternion +Represents 3D rotation and translation. +@see Dual, Quaternion, Matrix4 */ template class DualQuaternion: public Dual> { public: diff --git a/src/Math/Matrix3.h b/src/Math/Matrix3.h index 5a181213d..86862bc39 100644 --- a/src/Math/Matrix3.h +++ b/src/Math/Matrix3.h @@ -25,11 +25,10 @@ namespace Magnum { namespace Math { /** -@brief 3x3 matrix for transformations in 2D +@brief 3x3 matrix @tparam T Underlying data type -Provides functions for transformations in 2D. See Matrix4 for 3D -transformations. See also @ref matrix-vector for brief introduction. +Represents 2D transformation. See @ref matrix-vector for brief introduction. @see Magnum::Matrix3, SceneGraph::MatrixTransformation2D @configurationvalueref{Magnum::Math::Matrix3} */ diff --git a/src/Math/Matrix4.h b/src/Math/Matrix4.h index 55234ba82..4db6c9c71 100644 --- a/src/Math/Matrix4.h +++ b/src/Math/Matrix4.h @@ -25,12 +25,11 @@ namespace Magnum { namespace Math { /** -@brief 4x4 matrix for transformations in 3D +@brief 4x4 matrix @tparam T Underlying data type -Provides functions for transformations in 3D. See Matrix3 for 2D -transformations. See also @ref matrix-vector for brief introduction. -@see Magnum::Matrix4, SceneGraph::MatrixTransformation3D +Represents 3D transformation. See @ref matrix-vector for brief introduction. +@see Magnum::Matrix4, DualQuaternion, SceneGraph::MatrixTransformation3D @configurationvalueref{Magnum::Math::Matrix4} */ template class Matrix4: public Matrix<4, T> { diff --git a/src/Math/Quaternion.h b/src/Math/Quaternion.h index 4e7cc1edf..8f9a451be 100644 --- a/src/Math/Quaternion.h +++ b/src/Math/Quaternion.h @@ -34,7 +34,8 @@ namespace Magnum { namespace Math { @brief %Quaternion @tparam T Underlying data type -@see DualQuaternion, Magnum::Quaternion +Represents 3D rotation. +@see Magnum::Quaternion, DualQuaternion, Matrix4 */ template class Quaternion { public: @@ -238,7 +239,7 @@ template class Quaternion { * @see operator+=() */ inline Quaternion operator+(const Quaternion& other) const { - return Quaternion(*this)+=other; + return Quaternion(*this) += other; } /** @@ -271,7 +272,7 @@ template class Quaternion { * @see operator-=() */ inline Quaternion operator-(const Quaternion& other) const { - return Quaternion(*this)-=other; + return Quaternion(*this) -= other; } /** @@ -293,7 +294,7 @@ template class Quaternion { * @see operator*=(T) */ inline Quaternion operator*(T scalar) const { - return Quaternion(*this)*=scalar; + return Quaternion(*this) *= scalar; } /** @@ -315,7 +316,7 @@ template class Quaternion { * @see operator/=(T) */ inline Quaternion operator/(T scalar) const { - return Quaternion(*this)/=scalar; + return Quaternion(*this) /= scalar; } /**