From 17f0112732c389989f0bee69cf0e471d26d9027a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 3 Feb 2020 17:29:45 +0100 Subject: [PATCH] SceneGraph: doc++, show privates as private. Forgot to remove the protected doxygen override when implementing this doxygen feature a year ago. --- src/Magnum/SceneGraph/AbstractTranslation.h | 4 +-- .../AbstractTranslationRotation2D.h | 8 ++--- .../AbstractTranslationRotation3D.h | 20 +++++------- .../AbstractTranslationRotationScaling2D.h | 8 ++--- .../AbstractTranslationRotationScaling3D.h | 8 ++--- .../SceneGraph/DualComplexTransformation.h | 12 +++---- .../SceneGraph/DualQuaternionTransformation.h | 12 +++---- .../SceneGraph/RigidMatrixTransformation2D.h | 16 +++++----- .../SceneGraph/RigidMatrixTransformation3D.h | 28 ++++++++--------- ...anslationRotationScalingTransformation2D.h | 16 +++++----- ...anslationRotationScalingTransformation3D.h | 31 +++++++++---------- .../SceneGraph/TranslationTransformation.h | 4 +-- 12 files changed, 75 insertions(+), 92 deletions(-) diff --git a/src/Magnum/SceneGraph/AbstractTranslation.h b/src/Magnum/SceneGraph/AbstractTranslation.h index 4cd023c42..6a134fc20 100644 --- a/src/Magnum/SceneGraph/AbstractTranslation.h +++ b/src/Magnum/SceneGraph/AbstractTranslation.h @@ -58,7 +58,7 @@ class AbstractTranslation: public AbstractTransformation { explicit AbstractTranslation() = default; /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * @see @ref translateLocal(), @ref Math::Vector2::xAxis(), @@ -71,7 +71,7 @@ class AbstractTranslation: public AbstractTransformation { } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h index 0d5d4e743..2fdfe2ffd 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation2D.h @@ -47,7 +47,7 @@ template class AbstractBasicTranslationRotation2D: public AbstractBasic explicit AbstractBasicTranslationRotation2D() = default; /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -59,7 +59,7 @@ template class AbstractBasicTranslationRotation2D: public AbstractBasic } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -88,11 +88,7 @@ template class AbstractBasicTranslationRotation2D: public AbstractBasic protected: ~AbstractBasicTranslationRotation2D() = default; - #ifdef DOXYGEN_GENERATING_OUTPUT - protected: - #else private: - #endif /** @brief Polymorphic implementation for @ref rotate() */ virtual void doRotate(Math::Rad angle) = 0; diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h index 80c286893..16c7ffad4 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotation3D.h @@ -48,7 +48,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic explicit AbstractBasicTranslationRotation3D() = default; /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @param normalizedAxis Normalized rotation axis * @return Reference to self (for method chaining) @@ -63,7 +63,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -74,7 +74,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around X axis + * @brief Rotate the object around X axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -89,7 +89,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around X axis as a local transformation + * @brief Rotate the object around X axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. In some implementations faster than calling @@ -102,7 +102,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around Y axis + * @brief Rotate the object around Y axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -117,7 +117,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around Y axis as a local transformation + * @brief Rotate the object around Y axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. In some implementations faster than calling @@ -130,7 +130,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around Z axis + * @brief Rotate the object around Z axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -145,7 +145,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic } /** - * @brief Rotate object around Z axis as a local transformation + * @brief Rotate the object around Z axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. In some implementations faster than calling @@ -176,11 +176,7 @@ template class AbstractBasicTranslationRotation3D: public AbstractBasic protected: ~AbstractBasicTranslationRotation3D() = default; - #ifdef DOXYGEN_GENERATING_OUTPUT - protected: - #else private: - #endif /** @brief Polymorphic implementation for @ref rotate() */ virtual void doRotate(Math::Rad angle, const Math::Vector3& normalizedAxis) = 0; diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h index 3e9f39491..54143df54 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling2D.h @@ -47,7 +47,7 @@ template class AbstractBasicTranslationRotationScaling2D: public Abstra explicit AbstractBasicTranslationRotationScaling2D() = default; /** - * @brief Scale object + * @brief Scale the object * @return Reference to self (for method chaining) * * @see @ref scaleLocal(), @ref Math::Vector2::xScale(), @@ -59,7 +59,7 @@ template class AbstractBasicTranslationRotationScaling2D: public Abstra } /** - * @brief Scale object as a local transformation + * @brief Scale the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -96,11 +96,7 @@ template class AbstractBasicTranslationRotationScaling2D: public Abstra protected: ~AbstractBasicTranslationRotationScaling2D() = default; - #ifdef DOXYGEN_GENERATING_OUTPUT - protected: - #else private: - #endif /** @brief Polymorphic implementation for @ref scale() */ virtual void doScale(const Math::Vector2& vector) = 0; diff --git a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h index 717af932d..4a95fc93b 100644 --- a/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h +++ b/src/Magnum/SceneGraph/AbstractTranslationRotationScaling3D.h @@ -47,7 +47,7 @@ template class AbstractBasicTranslationRotationScaling3D: public Abstra explicit AbstractBasicTranslationRotationScaling3D() = default; /** - * @brief Scale object + * @brief Scale the object * @return Reference to self (for method chaining) * * @see @ref scaleLocal(), @ref Math::Vector3::xScale(), @@ -59,7 +59,7 @@ template class AbstractBasicTranslationRotationScaling3D: public Abstra } /** - * @brief Scale object as a local transformation + * @brief Scale the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -120,11 +120,7 @@ template class AbstractBasicTranslationRotationScaling3D: public Abstra protected: ~AbstractBasicTranslationRotationScaling3D() = default; - #ifdef DOXYGEN_GENERATING_OUTPUT - protected: - #else private: - #endif /** @brief Polymorphic implementation for @ref scale() */ virtual void doScale(const Math::Vector3& vector) = 0; diff --git a/src/Magnum/SceneGraph/DualComplexTransformation.h b/src/Magnum/SceneGraph/DualComplexTransformation.h index 2623ce323..f229cf8ec 100644 --- a/src/Magnum/SceneGraph/DualComplexTransformation.h +++ b/src/Magnum/SceneGraph/DualComplexTransformation.h @@ -83,7 +83,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Transform object + * @brief Transform the object * @return Reference to self (for method chaining) * * Expects that the dual complex number is normalized. @@ -97,7 +97,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Transform object as a local transformation + * @brief Transform the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -110,7 +110,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Same as calling @ref transform() with @ref Math::DualComplex::translation(). @@ -122,7 +122,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -133,7 +133,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -145,7 +145,7 @@ template class BasicDualComplexTransformation: public AbstractBasicTran } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. diff --git a/src/Magnum/SceneGraph/DualQuaternionTransformation.h b/src/Magnum/SceneGraph/DualQuaternionTransformation.h index 88d86955d..fc481dbf4 100644 --- a/src/Magnum/SceneGraph/DualQuaternionTransformation.h +++ b/src/Magnum/SceneGraph/DualQuaternionTransformation.h @@ -83,7 +83,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Transform object + * @brief Transform the object * @return Reference to self (for method chaining) * * Expects that the dual quaternion is normalized. @@ -97,7 +97,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Transform object as a local transformation + * @brief Transform the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -110,7 +110,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Same as calling @ref transform() with @ref Math::DualQuaternion::translation(). @@ -122,7 +122,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -132,7 +132,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @param normalizedAxis Normalized rotation axis * @return Reference to self (for method chaining) @@ -147,7 +147,7 @@ template class BasicDualQuaternionTransformation: public AbstractBasicT } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h index 487b013c4..431786ce3 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation2D.h @@ -88,7 +88,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Transform object + * @brief Transform the object * @return Reference to self (for method chaining) * * Expects that the matrix represents rigid transformation. @@ -102,7 +102,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Transform object as a local transformation + * @brief Transform the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -115,7 +115,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Same as calling @ref transform() with @ref Math::Matrix3::translation(). @@ -127,7 +127,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -138,7 +138,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -150,7 +150,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -162,7 +162,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Reflect object + * @brief Reflect the object * @param normal Normal of the line through which to reflect * (normalized) * @return Reference to self (for method chaining) @@ -175,7 +175,7 @@ template class BasicRigidMatrixTransformation2D: public AbstractBasicTr } /** - * @brief Reflect object as a local transformation + * @brief Reflect the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with diff --git a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h index f9f28ac47..9b34b84ca 100644 --- a/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h +++ b/src/Magnum/SceneGraph/RigidMatrixTransformation3D.h @@ -87,7 +87,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Transform object + * @brief Transform the object * @return Reference to self (for method chaining) * * Expects that the matrix represents rigid transformation. @@ -101,7 +101,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Transform object as a local transformation + * @brief Transform the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. @@ -114,7 +114,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Same as calling @ref transform() with @ref Math::Matrix4::translation(). @@ -126,7 +126,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -137,7 +137,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @param normalizedAxis Normalized rotation axis * @return Reference to self (for method chaining) @@ -153,7 +153,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -164,7 +164,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around X axis + * @brief Rotate the object around X axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -176,7 +176,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around X axis as a local transformation + * @brief Rotate the object around X axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -187,7 +187,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around Y axis + * @brief Rotate the object around Y axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -199,7 +199,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around Y axis as a local transformation + * @brief Rotate the object around Y axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -210,7 +210,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around Z axis + * @brief Rotate the object around Z axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -222,7 +222,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Rotate object around Z axis as a local transformation + * @brief Rotate the object around Z axis as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with @@ -233,7 +233,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Reflect object + * @brief Reflect the object * @param normal Normal of the plane through which to reflect * (normalized) * @return Reference to self (for method chaining) @@ -246,7 +246,7 @@ template class BasicRigidMatrixTransformation3D: public AbstractBasicTr } /** - * @brief Reflect object as a local transformation + * @brief Reflect the object as a local transformation * * Similar to the above, except that the transformation is applied * before all others. Same as calling @ref transformLocal() with diff --git a/src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h b/src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h index 2d5a06624..8d48fa474 100644 --- a/src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h +++ b/src/Magnum/SceneGraph/TranslationRotationScalingTransformation2D.h @@ -106,7 +106,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Note that translation is always applied last, after rotation and @@ -119,7 +119,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Equivalent to the above, as translation is commutative. Note that * translation is always applied last, after rotation and scaling. @@ -129,7 +129,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Rotate object using a complex number + * @brief Rotate the object using a complex number * @param complex Normalized complex number * @return Reference to self (for method chaining) * @@ -143,7 +143,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Rotate object using a complex number as a local transformation + * @brief Rotate the object using a complex number as a local transformation * * Equivalent to the above, as 2D rotation is commutative. Note that * rotation is always applied after scaling and before translation. @@ -153,7 +153,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -167,7 +167,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -180,7 +180,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Scale object + * @brief Scale the object * @return Reference to self (for method chaining) * * Note that scaling is always applied first, before rotation and @@ -193,7 +193,7 @@ template class BasicTranslationRotationScalingTransformation2D: public } /** - * @brief Scale object as a local transformation + * @brief Scale the object as a local transformation * * Equivalent to the above, as scaling is commutative. Note that * scaling is always first, before rotation and translation. diff --git a/src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h b/src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h index 26929a655..02450cbee 100644 --- a/src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h +++ b/src/Magnum/SceneGraph/TranslationRotationScalingTransformation3D.h @@ -106,7 +106,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Translate object + * @brief Translate the object * @return Reference to self (for method chaining) * * Note that translation is always applied last, after rotation and @@ -119,7 +119,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Translate object as a local transformation + * @brief Translate the object as a local transformation * * Equivalent to the above, as translation is commutative. Note that * translation is always applied last, after rotation and scaling. @@ -129,7 +129,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object using a quaternion + * @brief Rotate the object using a quaternion * @param quaternion Normalized quaternion * @return Reference to self (for method chaining) * @@ -137,15 +137,14 @@ template class BasicTranslationRotationScalingTransformation3D: public * translation. Expects that the quaternion is normalized. * @see @ref rotate(Math::Rad, const Math::Vector3&), * @ref rotateLocal(const Math::Quaternion&), @ref rotateX(), - * @ref rotateY(), @ref rotateZ(), @ref Math::Vector3::xAxis(), - * @ref Math::Vector3::yAxis(), @ref Math::Vector3::zAxis() + * @ref rotateY(), @ref rotateZ() */ Object>& rotate(const Math::Quaternion& quaternion) { return setRotation(quaternion*_rotation); } /** - * @brief Rotate object using a quaternion as a local transformation + * @brief Rotate the object using a quaternion as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -156,7 +155,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object + * @brief Rotate the object * @param angle Angle (counterclockwise) * @param normalizedAxis Normalized rotation axis * @return Reference to self (for method chaining) @@ -173,7 +172,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object as a local transformation + * @brief Rotate the object as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -186,7 +185,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around X axis + * @brief Rotate the object around X axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -199,7 +198,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around X axis as a local transformation + * @brief Rotate the object around X axis as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -211,7 +210,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around Y axis + * @brief Rotate the object around Y axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -224,7 +223,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around Y axis as a local transformation + * @brief Rotate the object around Y axis as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -236,7 +235,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around Z axis + * @brief Rotate the object around Z axis * @param angle Angle (counterclockwise) * @return Reference to self (for method chaining) * @@ -249,7 +248,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Rotate object around Z axis as a local transformation + * @brief Rotate the object around Z axis as a local transformation * * Similar to the above, except that the rotation is applied before all * other rotations. Note that rotation is always applied after scaling @@ -261,7 +260,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Scale object + * @brief Scale the object * @return Reference to self (for method chaining) * * Note that scaling is always applied first, before rotation and @@ -274,7 +273,7 @@ template class BasicTranslationRotationScalingTransformation3D: public } /** - * @brief Scale object as a local transformation + * @brief Scale the object as a local transformation * * Equivalent to the above, as scaling is commutative. Note that * scaling is always first, before rotation and translation. diff --git a/src/Magnum/SceneGraph/TranslationTransformation.h b/src/Magnum/SceneGraph/TranslationTransformation.h index 5fef255b3..f5c3029b1 100644 --- a/src/Magnum/SceneGraph/TranslationTransformation.h +++ b/src/Magnum/SceneGraph/TranslationTransformation.h @@ -83,7 +83,7 @@ class TranslationTransformation: public AbstractTranslation