Browse Source

Math: doc++

pull/690/head
Vladimír Vondruš 3 months ago
parent
commit
e46678f312
  1. 2
      src/Magnum/Math/Bezier.h
  2. 2
      src/Magnum/Math/BitVector.h
  3. 2
      src/Magnum/Math/Complex.h
  4. 2
      src/Magnum/Math/CubicHermite.h
  5. 2
      src/Magnum/Math/Dual.h
  6. 2
      src/Magnum/Math/DualComplex.h
  7. 2
      src/Magnum/Math/DualQuaternion.h
  8. 2
      src/Magnum/Math/Frustum.h
  9. 2
      src/Magnum/Math/Quaternion.h
  10. 2
      src/Magnum/Math/Range.h
  11. 2
      src/Magnum/Math/RectangularMatrix.h
  12. 2
      src/Magnum/Math/Vector.h

2
src/Magnum/Math/Bezier.h

@ -166,7 +166,7 @@ template<UnsignedInt order, UnsignedInt dimensions, class T> class Bezier {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of @cpp order + 1 @ce elements, * one-dimensional fixed-size array of @cpp order + 1 @ce elements,
* i.e. @cpp T(&)[size] @ce. * i.e. @cpp T(&)[size] @ce.
* @see @ref operator[]() * @see @ref operator[]()

2
src/Magnum/Math/BitVector.h

@ -145,7 +145,7 @@ template<std::size_t size> class BitVector {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of @ref DataSize elements, i.e. * one-dimensional fixed-size array of @ref DataSize elements, i.e.
* @cpp UnsignedByte(&)[DataSize] @ce. * @cpp UnsignedByte(&)[DataSize] @ce.
* @see @ref operator[](), @ref set() * @see @ref operator[](), @ref set()

2
src/Magnum/Math/Complex.h

@ -188,7 +188,7 @@ template<class T> class Complex {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of two elements, i.e. * one-dimensional fixed-size array of two elements, i.e.
* @cpp T(&)[2] @ce. * @cpp T(&)[2] @ce.
* @see @ref real(), @ref imaginary() * @see @ref real(), @ref imaginary()

2
src/Magnum/Math/CubicHermite.h

@ -149,7 +149,7 @@ template<class T> class CubicHermite {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of three elements, i.e. * one-dimensional fixed-size array of three elements, i.e.
* @cpp T(&)[3] @ce. * @cpp T(&)[3] @ce.
* @see @ref inTangent(), @ref point(), @ref outTangent() * @see @ref inTangent(), @ref point(), @ref outTangent()

2
src/Magnum/Math/Dual.h

@ -135,7 +135,7 @@ template<class T> class Dual {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of two elements, i.e. * one-dimensional fixed-size array of two elements, i.e.
* @cpp T(&)[2] @ce. * @cpp T(&)[2] @ce.
* @see @ref real(), @ref dual() * @see @ref real(), @ref dual()

2
src/Magnum/Math/DualComplex.h

@ -197,7 +197,7 @@ template<class T> class DualComplex: public Dual<Complex<T>> {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of four elements, i.e. * one-dimensional fixed-size array of four elements, i.e.
* @cpp T(&)[4] @ce. * @cpp T(&)[4] @ce.
* @see @ref real(), @ref dual() * @see @ref real(), @ref dual()

2
src/Magnum/Math/DualQuaternion.h

@ -343,7 +343,7 @@ template<class T> class DualQuaternion: public Dual<Quaternion<T>> {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of eight elements, i.e. * one-dimensional fixed-size array of eight elements, i.e.
* @cpp T(&)[8] @ce. * @cpp T(&)[8] @ce.
* @see @ref real(), @ref dual() * @see @ref real(), @ref dual()

2
src/Magnum/Math/Frustum.h

@ -143,7 +143,7 @@ template<class T> class Frustum {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of 24 elements, i.e. * one-dimensional fixed-size array of 24 elements, i.e.
* @cpp T(&)[24] @ce. * @cpp T(&)[24] @ce.
* @see @ref operator[]() * @see @ref operator[]()

2
src/Magnum/Math/Quaternion.h

@ -419,7 +419,7 @@ template<class T> class Quaternion {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of four elements, i.e. * one-dimensional fixed-size array of four elements, i.e.
* @cpp T(&)[4] @ce, vector part first, scalar after. * @cpp T(&)[4] @ce, vector part first, scalar after.
* @see @ref vector(), @ref scalar() * @see @ref vector(), @ref scalar()

2
src/Magnum/Math/Range.h

@ -206,7 +206,7 @@ template<UnsignedInt dimensions, class T> class Range {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of @cpp dimensions*2 @ce elements, * one-dimensional fixed-size array of @cpp dimensions*2 @ce elements,
* i.e. @cpp T(&)[dimensions*2] @ce. * i.e. @cpp T(&)[dimensions*2] @ce.
* @see @ref min(), @ref max() * @see @ref min(), @ref max()

2
src/Magnum/Math/RectangularMatrix.h

@ -246,7 +246,7 @@ template<std::size_t cols, std::size_t rows, class T> class RectangularMatrix {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of @cpp cols*rows @ce elements, * one-dimensional fixed-size array of @cpp cols*rows @ce elements,
* i.e. @cpp T(&)[cols*rows] @ce. * i.e. @cpp T(&)[cols*rows] @ce.
* @see @ref operator[]() * @see @ref operator[]()

2
src/Magnum/Math/Vector.h

@ -268,7 +268,7 @@ template<std::size_t size, class T> class Vector {
/** /**
* @brief Raw data * @brief Raw data
* *
* Contrary to what Doxygen shows, returns reference to an * Contrary to what Doxygen shows, returns reference to a
* one-dimensional fixed-size array of `size` elements, i.e. * one-dimensional fixed-size array of `size` elements, i.e.
* @cpp T(&)[size] @ce. * @cpp T(&)[size] @ce.
* @see @ref operator[]() * @see @ref operator[]()

Loading…
Cancel
Save