diff --git a/glm/detail/func_common.hpp b/glm/detail/func_common.hpp index 7fe07bcf..483fe2a9 100644 --- a/glm/detail/func_common.hpp +++ b/glm/detail/func_common.hpp @@ -34,7 +34,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or signed integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL abs man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -45,7 +45,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL sign man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -56,7 +56,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL floor man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -68,7 +68,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL trunc man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -83,7 +83,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL round man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -96,7 +96,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL roundEven man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -109,7 +109,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL ceil man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -129,7 +129,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL fract man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -151,7 +151,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL mod man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -163,7 +163,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL mod man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -195,7 +195,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL min man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -206,7 +206,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL min man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -226,7 +226,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL max man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -237,7 +237,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL max man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -259,7 +259,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL clamp man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -271,7 +271,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point or integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL clamp man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -340,7 +340,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL step man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -351,7 +351,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL step man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -391,7 +391,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL isnan man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -406,7 +406,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL isinf man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -426,7 +426,7 @@ namespace glm /// value's bit-level representation is preserved. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL floatBitsToInt man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -446,7 +446,7 @@ namespace glm /// value's bit-level representation is preserved. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL floatBitsToUint man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -470,7 +470,7 @@ namespace glm /// the bit-level representation is preserved. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL intBitsToFloat man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions @@ -494,7 +494,7 @@ namespace glm /// the bit-level representation is preserved. /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see GLSL uintBitsToFloat man page /// @see GLSL 4.20.8 specification, section 8.3 Common Functions diff --git a/glm/detail/func_matrix.hpp b/glm/detail/func_matrix.hpp index 80621619..c37d10e3 100644 --- a/glm/detail/func_matrix.hpp +++ b/glm/detail/func_matrix.hpp @@ -96,7 +96,10 @@ namespace detail /// Multiply matrix x by matrix y component-wise, i.e., /// result[i][j] is the scalar product of x[i][j] and y[i][j]. /// - /// @tparam matType Floating-point matrix types. + /// @tparam C Integer between 1 and 4 included that qualify the number a column + /// @tparam R Integer between 1 and 4 included that qualify the number a row + /// @tparam T Floating-point or signed integer scalar types + /// @tparam Q Value from qualifier enum /// /// @see GLSL matrixCompMult man page /// @see GLSL 4.20.8 specification, section 8.6 Matrix Functions @@ -107,14 +110,22 @@ namespace detail /// and the second parameter r as a row vector /// and does a linear algebraic matrix multiply c * r. /// + /// @tparam C Integer between 1 and 4 included that qualify the number a column + /// @tparam R Integer between 1 and 4 included that qualify the number a row + /// @tparam T Floating-point or signed integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see GLSL outerProduct man page /// @see GLSL 4.20.8 specification, section 8.6 Matrix Functions - template - GLM_FUNC_DECL typename detail::outerProduct_trait::type outerProduct(vec const& c, vec const& r); + template + GLM_FUNC_DECL typename detail::outerProduct_trait::type outerProduct(vec const& c, vec const& r); /// Returns the transposed matrix of x /// - /// @tparam matType Floating-point matrix types. + /// @tparam C Integer between 1 and 4 included that qualify the number a column + /// @tparam R Integer between 1 and 4 included that qualify the number a row + /// @tparam T Floating-point or signed integer scalar types + /// @tparam Q Value from qualifier enum /// /// @see GLSL transpose man page /// @see GLSL 4.20.8 specification, section 8.6 Matrix Functions @@ -123,7 +134,10 @@ namespace detail /// Return the determinant of a squared matrix. /// - /// @tparam T Floating-point scalar types. + /// @tparam C Integer between 1 and 4 included that qualify the number a column + /// @tparam R Integer between 1 and 4 included that qualify the number a row + /// @tparam T Floating-point or signed integer scalar types + /// @tparam Q Value from qualifier enum /// /// @see GLSL determinant man page /// @see GLSL 4.20.8 specification, section 8.6 Matrix Functions @@ -132,7 +146,10 @@ namespace detail /// Return the inverse of a squared matrix. /// - /// @tparam T Floating-point scalar types. + /// @tparam C Integer between 1 and 4 included that qualify the number a column + /// @tparam R Integer between 1 and 4 included that qualify the number a row + /// @tparam T Floating-point or signed integer scalar types + /// @tparam Q Value from qualifier enum /// /// @see GLSL inverse man page /// @see GLSL 4.20.8 specification, section 8.6 Matrix Functions diff --git a/glm/detail/func_trigonometric.hpp b/glm/detail/func_trigonometric.hpp index 3e00e372..68e9024c 100644 --- a/glm/detail/func_trigonometric.hpp +++ b/glm/detail/func_trigonometric.hpp @@ -26,7 +26,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL radians man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -37,7 +37,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL degrees man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -49,7 +49,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL sin man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -61,7 +61,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL cos man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -72,7 +72,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL tan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -85,7 +85,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL asin man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -98,7 +98,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL acos man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -113,7 +113,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL atan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -125,7 +125,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL atan man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -136,7 +136,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL sinh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -147,7 +147,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL cosh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -158,7 +158,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL tanh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -169,7 +169,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL asinh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -181,7 +181,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL acosh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions @@ -193,7 +193,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Floating-point scalar types - /// @tparam P Enumeration value qualifier + /// @tparam Q Value from qualifier enum /// /// @see GLSL atanh man page /// @see GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions diff --git a/glm/gtc/bitfield.hpp b/glm/gtc/bitfield.hpp index b8c9ef3b..93fb1080 100644 --- a/glm/gtc/bitfield.hpp +++ b/glm/gtc/bitfield.hpp @@ -40,7 +40,7 @@ namespace glm /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector /// @tparam T Signed and unsigned integer scalar types - /// @tparam P Value from qualifier enum + /// @tparam Q Value from qualifier enum /// /// @see gtc_bitfield template @@ -54,6 +54,10 @@ namespace glm /// Rotate all bits to the right. All the bits dropped in the right side are inserted back on the left side. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Signed and unsigned integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_bitfield template GLM_FUNC_DECL vec bitfieldRotateRight(vec const& In, int Shift); @@ -66,6 +70,10 @@ namespace glm /// Rotate all bits to the left. All the bits dropped in the left side are inserted back on the right side. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Signed and unsigned integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_bitfield template GLM_FUNC_DECL vec bitfieldRotateLeft(vec const& In, int Shift); @@ -78,6 +86,10 @@ namespace glm /// Set to 1 a range of bits. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Signed and unsigned integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_bitfield template GLM_FUNC_DECL vec bitfieldFillOne(vec const& Value, int FirstBit, int BitCount); @@ -90,6 +102,10 @@ namespace glm /// Set to 0 a range of bits. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Signed and unsigned integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_bitfield template GLM_FUNC_DECL vec bitfieldFillZero(vec const& Value, int FirstBit, int BitCount); diff --git a/glm/gtc/matrix_transform.hpp b/glm/gtc/matrix_transform.hpp index 4a99d4c1..c1caf04f 100644 --- a/glm/gtc/matrix_transform.hpp +++ b/glm/gtc/matrix_transform.hpp @@ -54,6 +54,7 @@ namespace glm /// @see gtc_matrix_transform /// @see - translate(mat<4, 4, T, Q> const& m, T x, T y, T z) /// @see - translate(vec<3, T, Q> const& v) + /// @see glTranslate man page template GLM_FUNC_DECL mat<4, 4, T, Q> translate( mat<4, 4, T, Q> const& m, @@ -68,6 +69,7 @@ namespace glm /// @see gtc_matrix_transform /// @see - rotate(mat<4, 4, T, Q> const& m, T angle, T x, T y, T z) /// @see - rotate(T angle, vec<3, T, Q> const& v) + /// @see glRotate man page template GLM_FUNC_DECL mat<4, 4, T, Q> rotate( mat<4, 4, T, Q> const& m, @@ -82,6 +84,7 @@ namespace glm /// @see gtc_matrix_transform /// @see - scale(mat<4, 4, T, Q> const& m, T x, T y, T z) /// @see - scale(vec<3, T, Q> const& v) + /// @see glScale man page template GLM_FUNC_DECL mat<4, 4, T, Q> scale( mat<4, 4, T, Q> const& m, @@ -89,15 +92,10 @@ namespace glm /// Creates a matrix for an orthographic parallel viewing volume, using the default handedness. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param zNear - /// @param zFar /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform /// @see - glm::ortho(T const& left, T const& right, T const& bottom, T const& top) + /// @see glOrtho man page template GLM_FUNC_DECL mat<4, 4, T, defaultp> ortho( T left, @@ -109,12 +107,6 @@ namespace glm /// Creates a matrix for an orthographic parallel viewing volume, using left-handedness. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param zNear - /// @param zFar /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform /// @see - glm::ortho(T const& left, T const& right, T const& bottom, T const& top) @@ -129,12 +121,6 @@ namespace glm /// Creates a matrix for an orthographic parallel viewing volume, using right-handedness. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param zNear - /// @param zFar /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform /// @see - glm::ortho(T const& left, T const& right, T const& bottom, T const& top) @@ -149,13 +135,10 @@ namespace glm /// Creates a matrix for projecting two-dimensional coordinates onto the screen. /// - /// @param left - /// @param right - /// @param bottom - /// @param top /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform /// @see - glm::ortho(T const& left, T const& right, T const& bottom, T const& top, T const& zNear, T const& zFar) + /// @see gluOrtho2D man page template GLM_FUNC_DECL mat<4, 4, T, defaultp> ortho( T left, @@ -165,14 +148,9 @@ namespace glm /// Creates a frustum matrix with default handedness. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param near - /// @param far /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform + /// @see glFrustum man page template GLM_FUNC_DECL mat<4, 4, T, defaultp> frustum( T left, @@ -184,12 +162,6 @@ namespace glm /// Creates a left handed frustum matrix. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param near - /// @param far /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform template @@ -203,12 +175,6 @@ namespace glm /// Creates a right handed frustum matrix. /// - /// @param left - /// @param right - /// @param bottom - /// @param top - /// @param near - /// @param far /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform template @@ -228,6 +194,7 @@ namespace glm /// @param far Specifies the distance from the viewer to the far clipping plane (always positive). /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform + /// @see gluPerspective man page template GLM_FUNC_DECL mat<4, 4, T, defaultp> perspective( T fovy, @@ -268,8 +235,8 @@ namespace glm /// Builds a perspective projection matrix based on a field of view and the default handedness. /// /// @param fov Expressed in radians. - /// @param width - /// @param height + /// @param width Width of the viewport + /// @param height Height of the viewport /// @param near Specifies the distance from the viewer to the near clipping plane (always positive). /// @param far Specifies the distance from the viewer to the far clipping plane (always positive). /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. @@ -285,8 +252,8 @@ namespace glm /// Builds a right handed perspective projection matrix based on a field of view. /// /// @param fov Expressed in radians. - /// @param width - /// @param height + /// @param width Width of the viewport + /// @param height Height of the viewport /// @param near Specifies the distance from the viewer to the near clipping plane (always positive). /// @param far Specifies the distance from the viewer to the far clipping plane (always positive). /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. @@ -302,8 +269,8 @@ namespace glm /// Builds a left handed perspective projection matrix based on a field of view. /// /// @param fov Expressed in radians. - /// @param width - /// @param height + /// @param width Width of the viewport + /// @param height Height of the viewport /// @param near Specifies the distance from the viewer to the near clipping plane (always positive). /// @param far Specifies the distance from the viewer to the far clipping plane (always positive). /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. @@ -365,7 +332,7 @@ namespace glm /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. /// @param aspect Specifies the aspect ratio that determines the field of view in the x direction. The aspect ratio is the ratio of x (width) to y (height). /// @param near Specifies the distance from the viewer to the near clipping plane (always positive). - /// @param ep + /// @param ep Epsilon /// @tparam T Value type used to build the matrix. Currently supported: half (not recommanded), float or double. /// @see gtc_matrix_transform template @@ -382,6 +349,7 @@ namespace glm /// @tparam T Native type used for the computation. Currently supported: half (not recommanded), float or double. /// @tparam U Currently supported: Floating-point types and integer types. /// @see gtc_matrix_transform + /// @see gluProject man page template GLM_FUNC_DECL vec<3, T, Q> project( vec<3, T, Q> const& obj, @@ -399,6 +367,7 @@ namespace glm /// @tparam T Native type used for the computation. Currently supported: half (not recommanded), float or double. /// @tparam U Currently supported: Floating-point types and integer types. /// @see gtc_matrix_transform + /// @see gluUnProject man page template GLM_FUNC_DECL vec<3, T, Q> unProject( vec<3, T, Q> const& win, @@ -408,12 +377,13 @@ namespace glm /// Define a picking region /// - /// @param center - /// @param delta - /// @param viewport + /// @param center Specify the center of a picking region in window coordinates. + /// @param delta Specify the width and height, respectively, of the picking region in window coordinates. + /// @param viewport Rendering viewport /// @tparam T Native type used for the computation. Currently supported: half (not recommanded), float or double. /// @tparam U Currently supported: Floating-point types and integer types. /// @see gtc_matrix_transform + /// @see gluPickMatrix man page template GLM_FUNC_DECL mat<4, 4, T, Q> pickMatrix( vec<2, T, Q> const& center, @@ -427,6 +397,7 @@ namespace glm /// @param up Normalized up vector, how the camera is oriented. Typically (0, 0, 1) /// @see gtc_matrix_transform /// @see - frustum(T const& left, T const& right, T const& bottom, T const& top, T const& nearVal, T const& farVal) frustum(T const& left, T const& right, T const& bottom, T const& top, T const& nearVal, T const& farVal) + /// @see gluLookAt man page template GLM_FUNC_DECL mat<4, 4, T, Q> lookAt( vec<3, T, Q> const& eye, diff --git a/glm/gtc/round.hpp b/glm/gtc/round.hpp index 31b73360..77bcabd8 100644 --- a/glm/gtc/round.hpp +++ b/glm/gtc/round.hpp @@ -38,6 +38,10 @@ namespace glm /// Return true if the value is a power of two number. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec isPowerOfTwo(vec const& value); @@ -52,6 +56,10 @@ namespace glm /// Return the power of two number which value is just higher the input value, /// round up to a power of two. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec ceilPowerOfTwo(vec const& value); @@ -66,6 +74,10 @@ namespace glm /// Return the power of two number which value is just lower the input value, /// round down to a power of two. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec floorPowerOfTwo(vec const& value); @@ -78,6 +90,10 @@ namespace glm /// Return the power of two number which value is the closet to the input value. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec roundPowerOfTwo(vec const& value); @@ -90,12 +106,20 @@ namespace glm /// Return true if the 'Value' is a multiple of 'Multiple'. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec isMultiple(vec const& Value, T Multiple); /// Return true if the 'Value' is a multiple of 'Multiple'. /// + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum + /// /// @see gtc_round template GLM_FUNC_DECL vec isMultiple(vec const& Value, vec const& Multiple); @@ -111,7 +135,9 @@ namespace glm /// Higher multiple number of Source. /// - /// @tparam genType Floating-point or integer scalar or vector types. + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum /// @param Multiple Must be a null or positive value /// /// @see gtc_round @@ -129,7 +155,9 @@ namespace glm /// Lower multiple number of Source. /// - /// @tparam genType Floating-point or integer scalar or vector types. + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum /// @param Multiple Must be a null or positive value /// /// @see gtc_round @@ -147,7 +175,9 @@ namespace glm /// Lower multiple number of Source. /// - /// @tparam genType Floating-point or integer scalar or vector types. + /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector + /// @tparam T Floating-point or integer scalar types + /// @tparam Q Value from qualifier enum /// @param Multiple Must be a null or positive value /// /// @see gtc_round diff --git a/glm/gtx/exterior_product.hpp b/glm/gtx/exterior_product.hpp index b97e8238..c5a9d60d 100644 --- a/glm/gtx/exterior_product.hpp +++ b/glm/gtx/exterior_product.hpp @@ -28,7 +28,8 @@ namespace glm /// Returns the cross product of x and y. /// - /// @tparam valType Floating-point scalar types. + /// @tparam T Floating-point scalar types + /// @tparam Q Value from qualifier enum /// /// @see Exterior product template