diff --git a/glm/ext/matrix_clip_space.hpp b/glm/ext/matrix_clip_space.hpp index 07ca540d..623c91c7 100644 --- a/glm/ext/matrix_clip_space.hpp +++ b/glm/ext/matrix_clip_space.hpp @@ -1,13 +1,9 @@ /// @ref ext_matrix_clip_space /// @file glm/ext/matrix_clip_space.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_matrix_clip_space GLM_EXT_matrix_clip_space /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Defines functions that generate common transformation matrices. /// /// The matrices generated by this extension use standard OpenGL fixed-function @@ -15,6 +11,8 @@ /// space into the specific eye space that the projective matrix functions /// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility /// specifications defines the particular layout of this eye space. +/// +/// Include to use the features of this extension. #pragma once diff --git a/glm/ext/matrix_projection.hpp b/glm/ext/matrix_projection.hpp index bd0ffabf..19f75727 100644 --- a/glm/ext/matrix_projection.hpp +++ b/glm/ext/matrix_projection.hpp @@ -1,8 +1,6 @@ /// @ref ext_matrix_projection /// @file glm/ext/matrix_projection.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_matrix_projection GLM_EXT_matrix_projection /// @ingroup ext /// @@ -43,7 +41,7 @@ namespace glm /// @return Return the computed window coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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> projectZO( @@ -59,7 +57,7 @@ namespace glm /// @return Return the computed window coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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> projectNO( @@ -75,7 +73,7 @@ namespace glm /// @return Return the computed window coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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( @@ -91,7 +89,7 @@ namespace glm /// @return Returns the computed object coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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> unProjectZO( @@ -107,7 +105,7 @@ namespace glm /// @return Returns the computed object coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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> unProjectNO( @@ -123,7 +121,7 @@ namespace glm /// @return Returns the computed object coordinates. /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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( @@ -136,7 +134,7 @@ namespace glm /// @param viewport Rendering viewport /// @tparam T Native type used for the computation. Currently supported: half (not recommended), 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( diff --git a/glm/ext/matrix_relational.hpp b/glm/ext/matrix_relational.hpp index 1711fd21..e16104ea 100644 --- a/glm/ext/matrix_relational.hpp +++ b/glm/ext/matrix_relational.hpp @@ -1,14 +1,12 @@ /// @ref ext_matrix_relational /// @file glm/ext/matrix_relational.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_matrix_relational GLM_EXT_matrix_relational /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Comparison functions for a user defined epsilon values. +/// +/// Include to use the features of this extension. #pragma once @@ -31,8 +29,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_matrix_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec equal(mat const& x, mat const& y); @@ -43,8 +39,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_matrix_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec equal(mat const& x, mat const& y, T epsilon); @@ -55,8 +49,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_matrix_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec equal(mat const& x, mat const& y, vec const& epsilon); @@ -67,8 +59,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_matrix_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec notEqual(mat const& x, mat const& y); @@ -79,8 +69,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_matrix_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec notEqual(mat const& x, mat const& y, T epsilon); @@ -91,8 +79,6 @@ namespace glm /// @tparam R Integer between 1 and 4 included that qualify the number of rows of the matrix /// @tparam T Floating-point or integer scalar types /// @tparam Q Value from qualifier enum - /// - /// @see ext_vector_relational template GLM_FUNC_DECL GLM_CONSTEXPR vec notEqual(mat const& x, mat const& y, vec const& epsilon); diff --git a/glm/ext/matrix_transform.hpp b/glm/ext/matrix_transform.hpp index 75f573f9..bce65bfa 100644 --- a/glm/ext/matrix_transform.hpp +++ b/glm/ext/matrix_transform.hpp @@ -1,8 +1,6 @@ /// @ref ext_matrix_transform /// @file glm/ext/matrix_transform.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_matrix_transform GLM_EXT_matrix_transform /// @ingroup ext /// @@ -52,7 +50,7 @@ namespace glm /// // m[2][0] == 0.0f, m[2][1] == 0.0f, m[2][2] == 1.0f, m[2][3] == 0.0f /// // m[3][0] == 1.0f, m[3][1] == 1.0f, m[3][2] == 1.0f, m[3][3] == 1.0f /// @endcode - /// @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 @@ -66,7 +64,7 @@ namespace glm /// @param angle Rotation angle expressed in radians. /// @param axis Rotation axis, recommended to be normalized. /// @tparam T Value type used to build the matrix. Supported: half, float or double. - /// @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 @@ -79,7 +77,7 @@ namespace glm /// @param m Input matrix multiplied by this scale matrix. /// @param v Ratio of scaling for each axis. /// @tparam T Value type used to build the matrix. Currently supported: half (not recommended), float or double. - /// @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 @@ -92,7 +90,7 @@ namespace glm /// @param eye Position of the camera /// @param center Position where the camera is looking at /// @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) template GLM_FUNC_DECL mat<4, 4, T, Q> lookAtRH( @@ -103,7 +101,7 @@ namespace glm /// @param eye Position of the camera /// @param center Position where the camera is looking at /// @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) template GLM_FUNC_DECL mat<4, 4, T, Q> lookAtLH( @@ -114,7 +112,7 @@ namespace glm /// @param eye Position of the camera /// @param center Position where the camera is looking at /// @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 diff --git a/glm/ext/quaternion_common.hpp b/glm/ext/quaternion_common.hpp index be60f324..93e38aca 100644 --- a/glm/ext/quaternion_common.hpp +++ b/glm/ext/quaternion_common.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_common /// @file glm/ext/quaternion_common.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_common GLM_EXT_quaternion_common /// @ingroup ext /// @@ -39,7 +37,6 @@ namespace glm /// @tparam T Floating-point scalar types. /// /// @see - slerp(qua const& x, qua const& y, T const& a) - /// @see ext_quaternion_common template GLM_FUNC_DECL qua mix(qua const& x, qua const& y, T a); @@ -50,8 +47,6 @@ namespace glm /// @param y A quaternion /// @param a Interpolation factor. The interpolation is defined in the range [0, 1]. /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL qua lerp(qua const& x, qua const& y, T a); @@ -62,24 +57,18 @@ namespace glm /// @param y A quaternion /// @param a Interpolation factor. The interpolation is defined beyond the range [0, 1]. /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL qua slerp(qua const& x, qua const& y, T a); /// Returns the q conjugate. /// /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL qua conjugate(qua const& q); /// Returns the q inverse. /// /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL qua inverse(qua const& q); @@ -92,8 +81,6 @@ namespace glm /// /!\ When using compiler fast math, this function may fail. /// /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL vec<4, bool, Q> isnan(qua const& x); @@ -104,8 +91,6 @@ namespace glm /// representations. /// /// @tparam T Floating-point scalar types. - /// - /// @see ext_quaternion_common template GLM_FUNC_DECL vec<4, bool, Q> isinf(qua const& x); diff --git a/glm/ext/quaternion_double.hpp b/glm/ext/quaternion_double.hpp index 20d09d3f..f0a056c2 100644 --- a/glm/ext/quaternion_double.hpp +++ b/glm/ext/quaternion_double.hpp @@ -1,14 +1,15 @@ /// @ref ext_quaternion_double /// @file glm/ext/quaternion_double.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_double GLM_EXT_quaternion_double /// @ingroup ext /// +/// Defines a templated quaternion type and several quaternion operations. +/// /// Include to use the features of this extension. /// -/// Defines a templated quaternion type and several quaternion operations. +/// @see ext_quaternion_float +/// @see ext_quaternion_double_precision #pragma once @@ -25,8 +26,6 @@ namespace glm /// @{ /// Quaternion of double-precision floating-point numbers. - /// - /// @see ext_quaternion_double typedef qua dquat; /// @} diff --git a/glm/ext/quaternion_double_precision.hpp b/glm/ext/quaternion_double_precision.hpp index ce9474d7..db034c2c 100644 --- a/glm/ext/quaternion_double_precision.hpp +++ b/glm/ext/quaternion_double_precision.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_double_precision /// @file glm/ext/quaternion_double_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_double_precision GLM_EXT_quaternion_double_precision /// @ingroup ext /// diff --git a/glm/ext/quaternion_exponential.hpp b/glm/ext/quaternion_exponential.hpp index c79522d2..1ca84789 100644 --- a/glm/ext/quaternion_exponential.hpp +++ b/glm/ext/quaternion_exponential.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_exponential /// @file glm/ext/quaternion_exponential.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_exponential GLM_EXT_quaternion_exponential /// @ingroup ext /// diff --git a/glm/ext/quaternion_float.hpp b/glm/ext/quaternion_float.hpp index 3c19c258..5b094258 100644 --- a/glm/ext/quaternion_float.hpp +++ b/glm/ext/quaternion_float.hpp @@ -1,14 +1,15 @@ /// @ref ext_quaternion_float /// @file glm/ext/quaternion_float.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_float GLM_EXT_quaternion_float /// @ingroup ext /// +/// Defines a templated quaternion type and several quaternion operations. +/// /// Include to use the features of this extension. /// -/// Defines a templated quaternion type and several quaternion operations. +/// @see ext_quaternion_double +/// @see ext_quaternion_float_precision #pragma once @@ -25,8 +26,6 @@ namespace glm /// @{ /// Quaternion of single-precision floating-point numbers. - /// - /// @see ext_quaternion_float typedef qua quat; /// @} diff --git a/glm/ext/quaternion_float_precision.hpp b/glm/ext/quaternion_float_precision.hpp index b516ad63..53dfcedb 100644 --- a/glm/ext/quaternion_float_precision.hpp +++ b/glm/ext/quaternion_float_precision.hpp @@ -1,14 +1,12 @@ /// @ref ext_quaternion_float_precision /// @file glm/ext/quaternion_float_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_float_precision GLM_EXT_quaternion_float_precision /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Defines a templated quaternion type and several quaternion operations. +/// +/// Include to use the features of this extension. #pragma once @@ -25,18 +23,12 @@ namespace glm /// @{ /// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs. - /// - /// @see ext_quaternion_float_precision typedef qua lowp_quat; /// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs. - /// - /// @see ext_quaternion_float_precision typedef qua mediump_quat; /// Quaternion of single-precision floating-point numbers using high precision arithmetic in term of ULPs. - /// - /// @see ext_quaternion_float_precision typedef qua highp_quat; /// @} diff --git a/glm/ext/quaternion_geometric.hpp b/glm/ext/quaternion_geometric.hpp index 033e6237..cbab2140 100644 --- a/glm/ext/quaternion_geometric.hpp +++ b/glm/ext/quaternion_geometric.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_geometric /// @file glm/ext/quaternion_geometric.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_geometric GLM_EXT_quaternion_geometric /// @ingroup ext /// diff --git a/glm/ext/quaternion_transform.hpp b/glm/ext/quaternion_transform.hpp index e7a5783e..c0e0f267 100644 --- a/glm/ext/quaternion_transform.hpp +++ b/glm/ext/quaternion_transform.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_transform /// @file glm/ext/quaternion_transform.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_transform GLM_EXT_quaternion_transform /// @ingroup ext /// diff --git a/glm/ext/quaternion_trigonometric.hpp b/glm/ext/quaternion_trigonometric.hpp index 3192ede5..44dc8457 100644 --- a/glm/ext/quaternion_trigonometric.hpp +++ b/glm/ext/quaternion_trigonometric.hpp @@ -1,8 +1,6 @@ /// @ref ext_quaternion_trigonometric /// @file glm/ext/quaternion_trigonometric.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_quaternion_trigonometric GLM_EXT_quaternion_trigonometric /// @ingroup ext /// diff --git a/glm/ext/scalar_common.hpp b/glm/ext/scalar_common.hpp index 64f76e22..3f1bdc19 100644 --- a/glm/ext/scalar_common.hpp +++ b/glm/ext/scalar_common.hpp @@ -1,14 +1,15 @@ /// @ref ext_scalar_common /// @file glm/ext/scalar_common.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_common GLM_EXT_scalar_common /// @ingroup ext /// +/// Min and max functions for 3 to 4 scalar parameters. +/// /// Include to use the features of this extension. /// -/// Min and max functions for 3 to 4 parameters. +/// @see core_func_common +/// @see ext_vector_common #pragma once @@ -27,26 +28,24 @@ namespace glm /// Returns the minimum component-wise values of 3 inputs /// /// @tparam T A floating-point scalar type. - /// - /// @see ext_scalar_common template GLM_FUNC_DECL T min(T a, T b, T c); /// Returns the minimum component-wise values of 4 inputs - /// @see ext_scalar_common + /// + /// @tparam T A floating-point scalar type. template GLM_FUNC_DECL T min(T a, T b, T c, T d); /// Returns the maximum component-wise values of 3 inputs /// /// @tparam T A floating-point scalar type. - /// - /// @see ext_scalar_common template GLM_FUNC_DECL T max(T a, T b, T c); /// Returns the maximum component-wise values of 4 inputs - /// @see ext_scalar_common + /// + /// @tparam T A floating-point scalar type. template GLM_FUNC_DECL T max(T a, T b, T c, T d); @@ -54,7 +53,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmin documentation template GLM_FUNC_DECL T fmin(T a, T b); @@ -63,7 +61,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmin documentation template GLM_FUNC_DECL T fmin(T a, T b, T c); @@ -72,7 +69,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmin documentation template GLM_FUNC_DECL T fmin(T a, T b, T c, T d); @@ -81,7 +77,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmax documentation template GLM_FUNC_DECL T fmax(T a, T b); @@ -90,7 +85,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmax documentation template GLM_FUNC_DECL T fmax(T a, T b, T C); @@ -99,7 +93,6 @@ namespace glm /// /// @tparam T A floating-point scalar type. /// - /// @see ext_scalar_common /// @see std::fmax documentation template GLM_FUNC_DECL T fmax(T a, T b, T C, T D); diff --git a/glm/ext/scalar_constants.hpp b/glm/ext/scalar_constants.hpp index 95edba71..1574465c 100644 --- a/glm/ext/scalar_constants.hpp +++ b/glm/ext/scalar_constants.hpp @@ -1,14 +1,12 @@ /// @ref ext_scalar_constants /// @file glm/ext/scalar_constants.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_constants GLM_EXT_scalar_constants /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Provide a list of constants and precomputed useful values. +/// +/// Include to use the features of this extension. #pragma once @@ -25,12 +23,10 @@ namespace glm /// @{ /// Return the epsilon constant for floating point types. - /// @see ext_scalar_constants template GLM_FUNC_DECL GLM_CONSTEXPR genType epsilon(); /// Return the pi constant for floating point types. - /// @see ext_scalar_constants template GLM_FUNC_DECL GLM_CONSTEXPR genType pi(); diff --git a/glm/ext/scalar_float_sized.hpp b/glm/ext/scalar_float_sized.hpp index 6b2aadc0..f257bfbc 100644 --- a/glm/ext/scalar_float_sized.hpp +++ b/glm/ext/scalar_float_sized.hpp @@ -1,14 +1,15 @@ /// @ref ext_scalar_float_sized /// @file glm/ext/scalar_float_sized.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_float_sized GLM_EXT_scalar_float_sized /// @ingroup ext /// +/// Exposes sized float scalar types. +/// /// Include to use the features of this extension. /// -/// Exposes float scalar type. +/// @see ext_scalar_int_sized +/// @see ext_scalar_uint_sized #pragma once @@ -23,23 +24,16 @@ namespace glm /// @addtogroup ext_scalar_float_sized /// @{ - /// Low qualifier floating-point numbers. - /// There is no guarantee on the actual qualifier. - /// - /// @see ext_scalar_float_sized + /// Single precision floating-point numbers. typedef float float32; # ifndef GLM_FORCE_SINGLE_ONLY - /// Low qualifier floating-point numbers. - /// There is no guarantee on the actual qualifier. - /// - /// @see ext_scalar_float_sized + /// Double precision floating-point numbers. typedef double float64; # endif//GLM_FORCE_SINGLE_ONLY /// @} - }//namespace glm diff --git a/glm/ext/scalar_int_sized.hpp b/glm/ext/scalar_int_sized.hpp index a5a30e7e..5dbd7845 100644 --- a/glm/ext/scalar_int_sized.hpp +++ b/glm/ext/scalar_int_sized.hpp @@ -1,14 +1,14 @@ /// @ref ext_scalar_int_sized /// @file glm/ext/scalar_int_sized.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_int_sized GLM_EXT_scalar_int_sized /// @ingroup ext /// +/// Exposes sized signed integer scalar types. +/// /// Include to use the features of this extension. /// -/// Exposes signed integer scalar type. +/// @see ext_scalar_uint_sized #pragma once @@ -55,19 +55,15 @@ namespace detail /// @{ /// 8 bit signed integer type. - /// @see ext_scalar_int_sized typedef detail::int8 int8; /// 16 bit signed integer type. - /// @see ext_scalar_int_sized typedef detail::int16 int16; /// 32 bit signed integer type. - /// @see ext_scalar_int_sized typedef detail::int32 int32; /// 64 bit signed integer type. - /// @see ext_scalar_int_sized typedef detail::int64 int64; /// @} diff --git a/glm/ext/scalar_relational.hpp b/glm/ext/scalar_relational.hpp index eacb063e..7a13e2d3 100644 --- a/glm/ext/scalar_relational.hpp +++ b/glm/ext/scalar_relational.hpp @@ -1,8 +1,6 @@ /// @ref ext_scalar_relational /// @file glm/ext/scalar_relational.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_relational GLM_EXT_scalar_relational /// @ingroup ext /// diff --git a/glm/ext/scalar_uint_sized.hpp b/glm/ext/scalar_uint_sized.hpp index f5743a27..fd5267fa 100644 --- a/glm/ext/scalar_uint_sized.hpp +++ b/glm/ext/scalar_uint_sized.hpp @@ -1,14 +1,14 @@ /// @ref ext_scalar_uint_sized /// @file glm/ext/scalar_uint_sized.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_scalar_uint_sized GLM_EXT_scalar_uint_sized /// @ingroup ext /// +/// Exposes sized unsigned integer scalar types. +/// /// Include to use the features of this extension. /// -/// Exposes unsigned integer scalar type. +/// @see ext_scalar_int_sized #pragma once @@ -55,19 +55,15 @@ namespace detail /// @{ /// 8 bit unsigned integer type. - /// @see ext_scalar_uint_sized typedef detail::uint8 uint8; /// 16 bit unsigned integer type. - /// @see ext_scalar_uint_sized typedef detail::uint16 uint16; /// 32 bit unsigned integer type. - /// @see ext_scalar_uint_sized typedef detail::uint32 uint32; /// 64 bit unsigned integer type. - /// @see ext_scalar_uint_sized typedef detail::uint64 uint64; /// @} diff --git a/glm/ext/vector_bool1.hpp b/glm/ext/vector_bool1.hpp index c636f860..002c3202 100644 --- a/glm/ext/vector_bool1.hpp +++ b/glm/ext/vector_bool1.hpp @@ -1,14 +1,14 @@ /// @ref ext_vector_bool1 /// @file glm/ext/vector_bool1.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_bool1 GLM_EXT_vector_bool1 /// @ingroup ext /// +/// Exposes bvec1 vector type. +/// /// Include to use the features of this extension. /// -/// Exposes bvec1 vector type. +/// @see ext_vector_bool1_precision extension. #pragma once @@ -24,8 +24,6 @@ namespace glm /// @{ /// 1 components vector of boolean. - /// - /// @see ext_vector_bool1 extension. typedef vec<1, bool, defaultp> bvec1; /// @} diff --git a/glm/ext/vector_bool1_precision.hpp b/glm/ext/vector_bool1_precision.hpp index 52f2f677..e62d3cfb 100644 --- a/glm/ext/vector_bool1_precision.hpp +++ b/glm/ext/vector_bool1_precision.hpp @@ -1,14 +1,12 @@ /// @ref ext_vector_bool1_precision /// @file glm/ext/vector_bool1_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_bool1_precision GLM_EXT_vector_bool1_precision /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Exposes highp_bvec1, mediump_bvec1 and lowp_bvec1 types. +/// +/// Include to use the features of this extension. #pragma once @@ -24,18 +22,12 @@ namespace glm /// @{ /// 1 component vector of bool values. - /// - /// @see ext_vector_bool1_precision typedef vec<1, bool, highp> highp_bvec1; /// 1 component vector of bool values. - /// - /// @see ext_vector_bool1_precision typedef vec<1, bool, mediump> mediump_bvec1; /// 1 component vector of bool values. - /// - /// @see ext_vector_bool1_precision typedef vec<1, bool, lowp> lowp_bvec1; /// @} diff --git a/glm/ext/vector_common.hpp b/glm/ext/vector_common.hpp index 208db26a..88cf271d 100644 --- a/glm/ext/vector_common.hpp +++ b/glm/ext/vector_common.hpp @@ -1,14 +1,15 @@ /// @ref ext_vector_common /// @file glm/ext/vector_common.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_common GLM_EXT_vector_common /// @ingroup ext /// +/// Min and max functions for 3 to 4 parameters. +/// /// Include to use the features of this extension. /// -/// Min and max functions for 3 to 4 parameters. +/// @see core_common +/// @see ext_scalar_common #pragma once @@ -30,8 +31,6 @@ 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 Q Value from qualifier enum - /// - /// @see ext_vector_common template GLM_FUNC_DECL GLM_CONSTEXPR vec min(vec const& a, vec const& b, vec const& c); @@ -40,8 +39,6 @@ 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 Q Value from qualifier enum - /// - /// @see ext_vector_common template GLM_FUNC_DECL GLM_CONSTEXPR vec min(vec const& a, vec const& b, vec const& c, vec const& d); @@ -50,8 +47,6 @@ 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 Q Value from qualifier enum - /// - /// @see ext_vector_common template GLM_FUNC_DECL GLM_CONSTEXPR vec max(vec const& x, vec const& y, vec const& z); @@ -60,8 +55,6 @@ 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 Q Value from qualifier enum - /// - /// @see ext_vector_common template GLM_FUNC_DECL GLM_CONSTEXPR vec max( vec const& x, vec const& y, vec const& z, vec const& w); @@ -71,7 +64,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmin documentation template GLM_FUNC_DECL vec fmin(vec const& x, T y); @@ -82,7 +74,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmin documentation template GLM_FUNC_DECL vec fmin(vec const& x, vec const& y); @@ -93,7 +84,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmin documentation template GLM_FUNC_DECL vec fmin(vec const& a, vec const& b, vec const& c); @@ -104,7 +94,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmin documentation template GLM_FUNC_DECL vec fmin(vec const& a, vec const& b, vec const& c, vec const& d); @@ -115,7 +104,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmax documentation template GLM_FUNC_DECL vec fmax(vec const& a, T b); @@ -126,7 +114,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmax documentation template GLM_FUNC_DECL vec fmax(vec const& a, vec const& b); @@ -137,7 +124,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmax documentation template GLM_FUNC_DECL vec fmax(vec const& a, vec const& b, vec const& c); @@ -148,7 +134,6 @@ namespace glm /// @tparam T Floating-point scalar types /// @tparam Q Value from qualifier enum /// - /// @see ext_vector_common /// @see std::fmax documentation template GLM_FUNC_DECL vec fmax(vec const& a, vec const& b, vec const& c, vec const& d); diff --git a/glm/ext/vector_double1.hpp b/glm/ext/vector_double1.hpp index 6b87215c..93afee0e 100644 --- a/glm/ext/vector_double1.hpp +++ b/glm/ext/vector_double1.hpp @@ -1,14 +1,15 @@ /// @ref ext_vector_double1 /// @file glm/ext/vector_double1.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_double1 GLM_EXT_vector_double1 /// @ingroup ext /// +/// Expose dvec1 vector type. +/// /// Include to use the features of this extension. /// -/// Expose dvec1 vector type. +/// @see ext_vector_double1_precision extension. +/// @see ext_vector_float1 extension. #pragma once @@ -24,8 +25,6 @@ namespace glm /// @{ /// 1 components vector of double-precision floating-point numbers. - /// - /// @see ext_vector_double1 extension. typedef vec<1, double, defaultp> dvec1; /// @} diff --git a/glm/ext/vector_double1_precision.hpp b/glm/ext/vector_double1_precision.hpp index f394d91c..1d471959 100644 --- a/glm/ext/vector_double1_precision.hpp +++ b/glm/ext/vector_double1_precision.hpp @@ -1,14 +1,14 @@ /// @ref ext_vector_double1_precision /// @file glm/ext/vector_double1_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_double1_precision GLM_EXT_vector_double1_precision /// @ingroup ext /// +/// Exposes highp_dvec1, mediump_dvec1 and lowp_dvec1 types. +/// /// Include to use the features of this extension. /// -/// Exposes highp_dvec1, mediump_dvec1 and lowp_dvec1 types. +/// @see ext_vector_double1 #pragma once @@ -24,18 +24,12 @@ namespace glm /// @{ /// 1 component vector of double-precision floating-point numbers using high precision arithmetic in term of ULPs. - /// - /// @see ext_vector_double1_precision typedef vec<1, double, highp> highp_dvec1; /// 1 component vector of double-precision floating-point numbers using medium precision arithmetic in term of ULPs. - /// - /// @see ext_vector_double1_precision typedef vec<1, double, mediump> mediump_dvec1; /// 1 component vector of double-precision floating-point numbers using low precision arithmetic in term of ULPs. - /// - /// @see ext_vector_double1_precision typedef vec<1, double, lowp> lowp_dvec1; /// @} diff --git a/glm/ext/vector_float1.hpp b/glm/ext/vector_float1.hpp index 5c660d30..b9355475 100644 --- a/glm/ext/vector_float1.hpp +++ b/glm/ext/vector_float1.hpp @@ -1,14 +1,14 @@ /// @ref ext_vector_float1 /// @file glm/ext/vector_float1.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_float1 GLM_EXT_vector_float1 /// @ingroup ext /// +/// Floating point vector type with one component. +/// /// Include to use the features of this extension. /// -/// Exposes vec1 vector type. +/// @see ext_vector_float1_precision extension. #pragma once @@ -25,7 +25,8 @@ namespace glm /// 1 components vector of single-precision floating-point numbers. /// - /// @see ext_vector_float1 extension. + /// @see ext_vector_float1_precision extension. + /// @see ext_vector_double1 extension. typedef vec<1, float, defaultp> vec1; /// @} diff --git a/glm/ext/vector_float1_precision.hpp b/glm/ext/vector_float1_precision.hpp index 238c8a42..bbf79bd1 100644 --- a/glm/ext/vector_float1_precision.hpp +++ b/glm/ext/vector_float1_precision.hpp @@ -1,14 +1,14 @@ /// @ref ext_vector_float1_precision /// @file glm/ext/vector_float1_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_float1_precision GLM_EXT_vector_float1_precision /// @ingroup ext /// /// Include to use the features of this extension. /// /// Exposes highp_vec1, mediump_vec1 and lowp_vec1 types. +/// +/// @see ext_vector_float1 extension. #pragma once @@ -25,17 +25,17 @@ namespace glm /// 1 component vector of single-precision floating-point numbers using high precision arithmetic in term of ULPs. /// - /// @see ext_vector_float1_precision + /// @see ext_vector_float1 typedef vec<1, float, highp> highp_vec1; /// 1 component vector of single-precision floating-point numbers using medium precision arithmetic in term of ULPs. /// - /// @see ext_vector_float1_precision + /// @see ext_vector_float1 typedef vec<1, float, mediump> mediump_vec1; /// 1 component vector of single-precision floating-point numbers using low precision arithmetic in term of ULPs. /// - /// @see ext_vector_float1_precision + /// @see ext_vector_float1 typedef vec<1, float, lowp> lowp_vec1; /// @} diff --git a/glm/ext/vector_int1.hpp b/glm/ext/vector_int1.hpp index 87ba28fe..dc860389 100644 --- a/glm/ext/vector_int1.hpp +++ b/glm/ext/vector_int1.hpp @@ -1,14 +1,15 @@ /// @ref ext_vector_int1 /// @file glm/ext/vector_int1.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_int1 GLM_EXT_vector_int1 /// @ingroup ext /// +/// Exposes ivec1 vector type. +/// /// Include to use the features of this extension. /// -/// Exposes ivec1 vector type. +/// @see ext_vector_uint1 extension. +/// @see ext_vector_int1_precision extension. #pragma once @@ -24,8 +25,6 @@ namespace glm /// @{ /// 1 component vector of signed integer numbers. - /// - /// @see ext_vector_int1 extension. typedef vec<1, int, defaultp> ivec1; /// @} diff --git a/glm/ext/vector_int1_precision.hpp b/glm/ext/vector_int1_precision.hpp index 747a61c8..c7a0498d 100644 --- a/glm/ext/vector_int1_precision.hpp +++ b/glm/ext/vector_int1_precision.hpp @@ -1,14 +1,12 @@ /// @ref ext_vector_int1_precision /// @file glm/ext/vector_int1_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_int1_precision GLM_EXT_vector_int1_precision /// @ingroup ext /// -/// Include to use the features of this extension. -/// /// Add Exposes highp_ivec1, mediump_ivec1 and lowp_ivec1 types. +/// +/// Include to use the features of this extension. #pragma once @@ -24,18 +22,12 @@ namespace glm /// @{ /// 1 component vector of signed integer values. - /// - /// @see ext_vector_int1_precision typedef vec<1, int, highp> highp_ivec1; /// 1 component vector of signed integer values. - /// - /// @see ext_vector_int1_precision typedef vec<1, int, mediump> mediump_ivec1; /// 1 component vector of signed integer values. - /// - /// @see ext_vector_int1_precision typedef vec<1, int, lowp> lowp_ivec1; /// @} diff --git a/glm/ext/vector_relational.hpp b/glm/ext/vector_relational.hpp index a78e96a0..ee5a76dc 100644 --- a/glm/ext/vector_relational.hpp +++ b/glm/ext/vector_relational.hpp @@ -1,14 +1,15 @@ /// @ref ext_vector_relational /// @file glm/ext/vector_relational.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_relational GLM_EXT_vector_relational /// @ingroup ext /// +/// Comparison functions for a user defined epsilon values. +/// /// Include to use the features of this extension. /// -/// Comparison functions for a user defined epsilon values. +/// @see core_vector_relational +/// @see ext_scalar_relational #pragma once diff --git a/glm/ext/vector_uint1.hpp b/glm/ext/vector_uint1.hpp index 9d9de6ac..eb8a7049 100644 --- a/glm/ext/vector_uint1.hpp +++ b/glm/ext/vector_uint1.hpp @@ -1,14 +1,15 @@ /// @ref ext_vector_uint1 /// @file glm/ext/vector_uint1.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_uint1 GLM_EXT_vector_uint1 /// @ingroup ext /// +/// Exposes uvec1 vector type. +/// /// Include to use the features of this extension. /// -/// Exposes uvec1 vector type. +/// @see ext_vector_int1 extension. +/// @see ext_vector_uint1_precision extension. #pragma once @@ -24,8 +25,6 @@ namespace glm /// @{ /// 1 component vector of unsigned integer numbers. - /// - /// @see ext_vector_uint1 extension. typedef vec<1, unsigned int, defaultp> uvec1; /// @} diff --git a/glm/ext/vector_uint1_precision.hpp b/glm/ext/vector_uint1_precision.hpp index ea0db2cf..fb618cb0 100644 --- a/glm/ext/vector_uint1_precision.hpp +++ b/glm/ext/vector_uint1_precision.hpp @@ -1,8 +1,6 @@ /// @ref ext_vector_uint1_precision /// @file glm/ext/vector_uint1_precision.hpp /// -/// @see core (dependence) -/// /// @defgroup ext_vector_uint1_precision GLM_EXT_vector_uint1_precision /// @ingroup ext ///