Browse Source

Math: doc++

pull/289/head
Vladimír Vondruš 8 years ago
parent
commit
eabe118266
  1. 2
      src/Magnum/Magnum.h
  2. 2
      src/Magnum/Math/Matrix.h
  3. 8
      src/Magnum/Math/Range.h
  4. 2
      src/Magnum/Math/RectangularMatrix.h

2
src/Magnum/Magnum.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Forward declarations for the @ref Magnum namespace
* @brief Forward declarations and basic types for the @ref Magnum namespace
*/
#include <Corrade/Utility/Utility.h>

2
src/Magnum/Math/Matrix.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::Matrix, typedef @ref Magnum::Math::Matrix2x2, @ref Magnum::Math::Matrix3x3, @ref Magnum::Math::Matrix4x4
* @brief Class @ref Magnum::Math::Matrix, alias @ref Magnum::Math::Matrix2x2, @ref Magnum::Math::Matrix3x3, @ref Magnum::Math::Matrix4x4
*/
#include "Magnum/Math/RectangularMatrix.h"

8
src/Magnum/Math/Range.h

@ -289,6 +289,8 @@ template<UnsignedInt dimensions, class T> class Range {
Convenience alternative to @cpp Range<1, T> @ce. See @ref Range for more
information.
@see @ref Range2D, @ref Range3D, @ref Magnum::Range1D, @ref Magnum::Range1Di,
@ref Magnum::Range1Dd
*/
#ifndef CORRADE_MSVC2015_COMPATIBILITY /* Multiple definitions still broken */
template<class T> using Range1D = Range<1, T>;
@ -298,7 +300,8 @@ template<class T> using Range1D = Range<1, T>;
@brief Two-dimensional range
See @ref Range for more information.
@see @ref Range1D, @ref Range3D
@see @ref Range1D, @ref Range3D, @ref Magnum::Range2D, @ref Magnum::Range2Di,
@ref Magnum::Range2Dd
*/
template<class T> class Range2D: public Range<2, T> {
public:
@ -440,7 +443,8 @@ template<class T> class Range2D: public Range<2, T> {
@brief Three-dimensional range
See @ref Range for more information.
@see @ref Range1D, @ref Range2D
@see @ref Range1D, @ref Range2D, @ref Magnum::Range3D, @ref Magnum::Range3Di,
@ref Magnum::Range3Dd
*/
template<class T> class Range3D: public Range<3, T> {
public:

2
src/Magnum/Math/RectangularMatrix.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Class @ref Magnum::Math::RectangularMatrix, typedef @ref Magnum::Math::Matrix2x3, @ref Magnum::Math::Matrix3x2, @ref Magnum::Math::Matrix2x4, @ref Magnum::Math::Matrix4x2, @ref Magnum::Math::Matrix3x4, @ref Magnum::Math::Matrix4x3
* @brief Class @ref Magnum::Math::RectangularMatrix, alias @ref Magnum::Math::Matrix2x3, @ref Magnum::Math::Matrix3x2, @ref Magnum::Math::Matrix2x4, @ref Magnum::Math::Matrix4x2, @ref Magnum::Math::Matrix3x4, @ref Magnum::Math::Matrix4x3
*/
#include "Magnum/Math/Vector.h"

Loading…
Cancel
Save