Browse Source

Math: doc++

pull/205/head
Vladimír Vondruš 8 years ago
parent
commit
a421b50be3
  1. 2
      src/Magnum/Math/Complex.h
  2. 2
      src/Magnum/Math/DualQuaternion.h
  3. 7
      src/Magnum/Math/Quaternion.h
  4. 2
      src/Magnum/Math/Vector.h
  5. 2
      src/Magnum/Math/Vector2.h
  6. 2
      src/Magnum/Math/Vector3.h
  7. 2
      src/Magnum/Math/Vector4.h

2
src/Magnum/Math/Complex.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Complex
* @brief Class @ref Magnum::Math::Complex, function @ref Magnum::Math::dot(), @ref Magnum::math::angle()
*/
#include <Corrade/Utility/Assert.h>

2
src/Magnum/Math/DualQuaternion.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::DualQuaternion
* @brief Class @ref Magnum::Math::DualQuaternion, function @ref Magnum::Math::sclerp()
*/
#include <cmath>

7
src/Magnum/Math/Quaternion.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Quaternion
* @brief Class @ref Magnum::Math::Quaternion, function @ref Magnum::Math::dot(), @ref Magnum::Math::angle(), @ref Magnum::Math::lerp(), @ref Magnum::Math::slerp()
*/
#include <cmath>
@ -88,7 +88,7 @@ Expects that both quaternions are normalized. @f[
q_{LERP} = \frac{(1 - t) q_A + t q_B}{|(1 - t) q_A + t q_B|}
@f]
@see @ref Quaternion::isNormalized(), @ref slerp(const Quaternion<T>&, const Quaternion<T>&, T),
@ref lerp(const T&, const T&, U)
@ref lerp(const T&, const T&, U), @ref sclerp()
*/
template<class T> inline Quaternion<T> lerp(const Quaternion<T>& normalizedA, const Quaternion<T>& normalizedB, T t) {
CORRADE_ASSERT(normalizedA.isNormalized() && normalizedB.isNormalized(),
@ -108,7 +108,8 @@ or one is a negation of the other, returns the first argument. @f[
~ ~ ~ ~ ~ ~ ~
\theta = acos \left( \frac{q_A \cdot q_B}{|q_A| \cdot |q_B|} \right) = acos(q_A \cdot q_B)
@f]
@see @ref Quaternion::isNormalized(), @ref lerp(const Quaternion<T>&, const Quaternion<T>&, T)
@see @ref Quaternion::isNormalized(), @ref lerp(const Quaternion<T>&, const Quaternion<T>&, T),
@ref sclerp()
*/
template<class T> inline Quaternion<T> slerp(const Quaternion<T>& normalizedA, const Quaternion<T>& normalizedB, T t) {
CORRADE_ASSERT(normalizedA.isNormalized() && normalizedB.isNormalized(),

2
src/Magnum/Math/Vector.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Vector
* @brief Class @ref Magnum::Math::Vector, function @ref Magnum::Math::dot(), @ref Magnum::Math::angle()
*/
#include <cmath>

2
src/Magnum/Math/Vector2.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Vector2
* @brief Class @ref Magnum::Math::Vector2, function @ref Magnum::Math::cross()
*/
#include "Magnum/Math/Vector.h"

2
src/Magnum/Math/Vector3.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Vector3
* @brief Class @ref Magnum::Math::Vector3, function @ref Magnum::Math::cross()
*/
#include "Magnum/Math/Vector2.h"

2
src/Magnum/Math/Vector4.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class Magnum::Math::Vector4
* @brief Class @ref Magnum::Math::Vector4
*/
#include "Magnum/Math/Vector3.h"

Loading…
Cancel
Save