diff --git a/glm/ext/matrix_clip_space.hpp b/glm/ext/matrix_clip_space.hpp index c3874f2f..dda58e7a 100644 --- a/glm/ext/matrix_clip_space.hpp +++ b/glm/ext/matrix_clip_space.hpp @@ -212,7 +212,7 @@ namespace glm T left, T right, T bottom, T top, T near, T far); - /// Creates a matrix for a right handed, symetric perspective-view frustum. + /// Creates a matrix for a right handed, symmetric perspective-view frustum. /// The near and far clip planes correspond to z normalized device coordinates of 0 and +1 respectively. (Direct3D clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -225,7 +225,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveRH_ZO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a right handed, symetric perspective-view frustum. + /// Creates a matrix for a right handed, symmetric perspective-view frustum. /// The near and far clip planes correspond to z normalized device coordinates of -1 and +1 respectively. (OpenGL clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -238,7 +238,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveRH_NO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a left handed, symetric perspective-view frustum. + /// Creates a matrix for a left handed, symmetric perspective-view frustum. /// The near and far clip planes correspond to z normalized device coordinates of 0 and +1 respectively. (Direct3D clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -251,7 +251,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveLH_ZO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a left handed, symetric perspective-view frustum. + /// Creates a matrix for a left handed, symmetric perspective-view frustum. /// The near and far clip planes correspond to z normalized device coordinates of -1 and +1 respectively. (OpenGL clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -264,7 +264,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveLH_NO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a symetric perspective-view frustum using left-handed coordinates if GLM_FORCE_LEFT_HANDED if defined or right-handed coordinates otherwise. + /// Creates a matrix for a symmetric perspective-view frustum using left-handed coordinates if GLM_FORCE_LEFT_HANDED if defined or right-handed coordinates otherwise. /// The near and far clip planes correspond to z normalized device coordinates of 0 and +1 respectively. (Direct3D clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -277,7 +277,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveZO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a symetric perspective-view frustum using left-handed coordinates if GLM_FORCE_LEFT_HANDED if defined or right-handed coordinates otherwise. + /// Creates a matrix for a symmetric perspective-view frustum using left-handed coordinates if GLM_FORCE_LEFT_HANDED if defined or right-handed coordinates otherwise. /// The near and far clip planes correspond to z normalized device coordinates of -1 and +1 respectively. (OpenGL clip volume definition) /// /// @param fovy Specifies the field of view angle, in degrees, in the y direction. Expressed in radians. @@ -290,7 +290,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveNO( T fovy, T aspect, T near, T far); - /// Creates a matrix for a right handed, symetric perspective-view frustum. + /// Creates a matrix for a right handed, symmetric perspective-view frustum. /// If GLM_FORCE_DEPTH_ZERO_TO_ONE is defined, the near and far clip planes correspond to z normalized device coordinates of 0 and +1 respectively. (Direct3D clip volume definition) /// Otherwise, the near and far clip planes correspond to z normalized device coordinates of -1 and +1 respectively. (OpenGL clip volume definition) /// @@ -304,7 +304,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveRH( T fovy, T aspect, T near, T far); - /// Creates a matrix for a left handed, symetric perspective-view frustum. + /// Creates a matrix for a left handed, symmetric perspective-view frustum. /// If GLM_FORCE_DEPTH_ZERO_TO_ONE is defined, the near and far clip planes correspond to z normalized device coordinates of 0 and +1 respectively. (Direct3D clip volume definition) /// Otherwise, the near and far clip planes correspond to z normalized device coordinates of -1 and +1 respectively. (OpenGL clip volume definition) /// @@ -318,7 +318,7 @@ namespace glm GLM_FUNC_DECL mat<4, 4, T, defaultp> perspectiveLH( T fovy, T aspect, T near, T far); - /// Creates a matrix for a symetric perspective-view frustum based on the default handedness and default near and far clip planes definition. + /// Creates a matrix for a symmetric perspective-view frustum based on the default handedness and default near and far clip planes definition. /// To change default handedness use GLM_FORCE_LEFT_HANDED. To change default near and far clip planes definition use GLM_FORCE_DEPTH_ZERO_TO_ONE. /// /// @param fovy Specifies the field of view angle in the y direction. Expressed in radians. diff --git a/glm/ext/matrix_float3x2.hpp b/glm/ext/matrix_float3x2.hpp index d39dd2fe..280d0a3e 100644 --- a/glm/ext/matrix_float3x2.hpp +++ b/glm/ext/matrix_float3x2.hpp @@ -6,7 +6,7 @@ namespace glm { - /// @addtogroup core + /// @addtogroup core_matrix /// @{ /// 3 columns of 2 components matrix of single-precision floating-point numbers. diff --git a/glm/ext/matrix_uint2x3.hpp b/glm/ext/matrix_uint2x3.hpp index 7de62f6f..f496c531 100644 --- a/glm/ext/matrix_uint2x3.hpp +++ b/glm/ext/matrix_uint2x3.hpp @@ -3,7 +3,7 @@ /// /// @see core (dependence) /// -/// @defgroup ext_matrix_int2x3 GLM_EXT_matrix_uint2x3 +/// @defgroup ext_matrix_uint2x3 GLM_EXT_matrix_uint2x3 /// @ingroup ext /// /// Include to use the features of this extension. diff --git a/glm/ext/matrix_uint2x4_sized.hpp b/glm/ext/matrix_uint2x4_sized.hpp index 5cb8e546..5c55547f 100644 --- a/glm/ext/matrix_uint2x4_sized.hpp +++ b/glm/ext/matrix_uint2x4_sized.hpp @@ -1,5 +1,5 @@ /// @ref ext_matrix_uint2x4_sized -/// @file glm/ext/matrixu_uint2x4_sized.hpp +/// @file glm/ext/matrix_uint2x4_sized.hpp /// /// @see core (dependence) /// diff --git a/glm/ext/matrix_uint3x2.hpp b/glm/ext/matrix_uint3x2.hpp index 47f48737..55a9bed6 100644 --- a/glm/ext/matrix_uint3x2.hpp +++ b/glm/ext/matrix_uint3x2.hpp @@ -3,7 +3,7 @@ /// /// @see core (dependence) /// -/// @defgroup ext_matrix_int3x2 GLM_EXT_matrix_uint3x2 +/// @defgroup ext_matrix_uint3x2 GLM_EXT_matrix_uint3x2 /// @ingroup ext /// /// Include to use the features of this extension. diff --git a/glm/ext/quaternion_geometric.hpp b/glm/ext/quaternion_geometric.hpp index 6d98bbe9..f4b9d6e6 100644 --- a/glm/ext/quaternion_geometric.hpp +++ b/glm/ext/quaternion_geometric.hpp @@ -8,7 +8,7 @@ /// /// Include to use the features of this extension. /// -/// @see core_geometric +/// @see core_func_geometric /// @see ext_quaternion_float /// @see ext_quaternion_double diff --git a/glm/ext/scalar_relational.hpp b/glm/ext/scalar_relational.hpp index 3076a5e6..e84df178 100644 --- a/glm/ext/scalar_relational.hpp +++ b/glm/ext/scalar_relational.hpp @@ -23,6 +23,9 @@ namespace glm { + /// @addtogroup ext_scalar_relational + /// @{ + /// Returns the component-wise comparison of |x - y| < epsilon. /// True if this expression is satisfied. /// diff --git a/glm/ext/scalar_ulp.hpp b/glm/ext/scalar_ulp.hpp index 941ada3e..6344d95b 100644 --- a/glm/ext/scalar_ulp.hpp +++ b/glm/ext/scalar_ulp.hpp @@ -26,6 +26,9 @@ namespace glm { + /// @addtogroup ext_scalar_ulp + /// @{ + /// Return the next ULP value(s) after the input value(s). /// /// @tparam genType A floating-point scalar type. diff --git a/glm/ext/vector_reciprocal.hpp b/glm/ext/vector_reciprocal.hpp index b383e3c3..84d67662 100644 --- a/glm/ext/vector_reciprocal.hpp +++ b/glm/ext/vector_reciprocal.hpp @@ -3,7 +3,7 @@ /// /// @see core (dependence) /// -/// @defgroup gtc_reciprocal GLM_EXT_vector_reciprocal +/// @defgroup ext_vector_reciprocal GLM_EXT_vector_reciprocal /// @ingroup ext /// /// Include to use the features of this extension. diff --git a/glm/ext/vector_ulp.hpp b/glm/ext/vector_ulp.hpp index 6210396b..7c539bbf 100644 --- a/glm/ext/vector_ulp.hpp +++ b/glm/ext/vector_ulp.hpp @@ -25,6 +25,9 @@ namespace glm { + /// @addtogroup ext_vector_ulp + /// @{ + /// Return the next ULP value(s) after the input value(s). /// /// @tparam L Integer between 1 and 4 included that qualify the dimension of the vector diff --git a/glm/glm.hpp b/glm/glm.hpp index 8b610649..8b375459 100644 --- a/glm/glm.hpp +++ b/glm/glm.hpp @@ -1,6 +1,11 @@ /// @ref core /// @file glm/glm.hpp /// +/// @mainpage OpenGL Mathematics (GLM) +/// - Website: glm.g-truc.net +/// - GLM API documentation +/// - GLM Manual +/// /// @defgroup core Core features /// /// @brief Features that implement in C++ the GLSL specification as closely as possible. @@ -95,10 +100,6 @@ /// at once by including . Otherwise, each extension needs to be /// included a specific file. /// -/// @mainpage OpenGL Mathematics (GLM) -/// - Website: glm.g-truc.net -/// - GLM API documentation -/// - GLM Manual #include "detail/_fixes.hpp" diff --git a/glm/gtc/integer.hpp b/glm/gtc/integer.hpp index a2a5bf6e..ee52e0e0 100644 --- a/glm/gtc/integer.hpp +++ b/glm/gtc/integer.hpp @@ -32,7 +32,7 @@ namespace glm /// @addtogroup gtc_integer /// @{ - /// Returns the log2 of x for integer values. Usefull to compute mipmap count from the texture size. + /// Returns the log2 of x for integer values. Useful to compute mipmap count from the texture size. /// @see gtc_integer template GLM_FUNC_DECL genIUType log2(genIUType x); diff --git a/glm/gtc/matrix_inverse.hpp b/glm/gtc/matrix_inverse.hpp index 8f778606..75d53f20 100644 --- a/glm/gtc/matrix_inverse.hpp +++ b/glm/gtc/matrix_inverse.hpp @@ -31,7 +31,7 @@ namespace glm /// Fast matrix inverse for affine matrix. /// /// @param m Input matrix to invert. - /// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-qualifier floating point value is highly innacurate. + /// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-qualifier floating point value is highly inaccurate. /// @see gtc_matrix_inverse template GLM_FUNC_DECL genType affineInverse(genType const& m); @@ -39,7 +39,7 @@ namespace glm /// Compute the inverse transpose of a matrix. /// /// @param m Input matrix to invert transpose. - /// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-qualifier floating point value is highly innacurate. + /// @tparam genType Squared floating-point matrix: half, float or double. Inverse of matrix based of half-qualifier floating point value is highly inaccurate. /// @see gtc_matrix_inverse template GLM_FUNC_DECL genType inverseTranspose(genType const& m); diff --git a/glm/gtc/random.hpp b/glm/gtc/random.hpp index 9a859580..c6485bf1 100644 --- a/glm/gtc/random.hpp +++ b/glm/gtc/random.hpp @@ -52,25 +52,25 @@ namespace glm template GLM_FUNC_DECL genType gaussRand(genType Mean, genType Deviation); - /// Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius + /// Generate a random 2D vector which coordinates are regularly distributed on a circle of a given radius /// /// @see gtc_random template GLM_FUNC_DECL vec<2, T, defaultp> circularRand(T Radius); - /// Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius + /// Generate a random 3D vector which coordinates are regularly distributed on a sphere of a given radius /// /// @see gtc_random template GLM_FUNC_DECL vec<3, T, defaultp> sphericalRand(T Radius); - /// Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius + /// Generate a random 2D vector which coordinates are regularly distributed within the area of a disk of a given radius /// /// @see gtc_random template GLM_FUNC_DECL vec<2, T, defaultp> diskRand(T Radius); - /// Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius + /// Generate a random 3D vector which coordinates are regularly distributed within the volume of a ball of a given radius /// /// @see gtc_random template diff --git a/glm/gtc/ulp.hpp b/glm/gtc/ulp.hpp index 0d80a758..7b918f0f 100644 --- a/glm/gtc/ulp.hpp +++ b/glm/gtc/ulp.hpp @@ -26,6 +26,9 @@ namespace glm { + /// @addtogroup gtc_ulp + /// @{ + /// Return the next ULP value(s) after the input value(s). /// /// @tparam genType A floating-point scalar type. diff --git a/glm/gtx/associated_min_max.hpp b/glm/gtx/associated_min_max.hpp index 0edd3b00..4c036add 100644 --- a/glm/gtx/associated_min_max.hpp +++ b/glm/gtx/associated_min_max.hpp @@ -9,7 +9,7 @@ /// /// Include to use the features of this extension. /// -/// @brief Min and max functions that return associated values not the compared onces. +/// @brief Min and max functions that return associated values not the compared ones. #pragma once diff --git a/glm/gtx/easing.hpp b/glm/gtx/easing.hpp index 57f3d61b..da89826a 100644 --- a/glm/gtx/easing.hpp +++ b/glm/gtx/easing.hpp @@ -9,7 +9,7 @@ /// /// Include to use the features of this extension. /// -/// Easing functions for animations and transitons +/// Easing functions for animations and transitions /// All functions take a parameter x in the range [0.0,1.0] /// /// Based on the AHEasing project of Warren Moore (https://github.com/warrenm/AHEasing) diff --git a/glm/gtx/extended_min_max.hpp b/glm/gtx/extended_min_max.hpp index 025eda29..20cd89b0 100644 --- a/glm/gtx/extended_min_max.hpp +++ b/glm/gtx/extended_min_max.hpp @@ -3,10 +3,10 @@ /// /// @see core (dependence) /// -/// @defgroup gtx_extended_min_max GLM_GTX_extented_min_max +/// @defgroup gtx_extended_min_max GLM_GTX_extended_min_max /// @ingroup gtx /// -/// Include to use the features of this extension. +/// Include to use the features of this extension. /// /// Min and max functions for 3 to 4 parameters. @@ -18,9 +18,9 @@ #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED) # ifndef GLM_ENABLE_EXPERIMENTAL -# pragma message("GLM: GLM_GTX_extented_min_max is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.") +# pragma message("GLM: GLM_GTX_extended_min_max is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.") # else -# pragma message("GLM: GLM_GTX_extented_min_max extension included") +# pragma message("GLM: GLM_GTX_extended_min_max extension included") # endif #endif diff --git a/glm/gtx/handed_coordinate_space.hpp b/glm/gtx/handed_coordinate_space.hpp index 3c859689..e59e3e2a 100644 --- a/glm/gtx/handed_coordinate_space.hpp +++ b/glm/gtx/handed_coordinate_space.hpp @@ -6,7 +6,7 @@ /// @defgroup gtx_handed_coordinate_space GLM_GTX_handed_coordinate_space /// @ingroup gtx /// -/// Include to use the features of this extension. +/// Include to use the features of this extension. /// /// To know if a set of three basis vectors defines a right or left-handed coordinate system. diff --git a/glm/gtx/hash.inl b/glm/gtx/hash.inl index ff71ca9f..11794ee9 100644 --- a/glm/gtx/hash.inl +++ b/glm/gtx/hash.inl @@ -1,13 +1,4 @@ /// @ref gtx_hash -/// -/// @see core (dependence) -/// -/// @defgroup gtx_hash GLM_GTX_hash -/// @ingroup gtx -/// -/// @brief Add std::hash support for glm types -/// -/// need to be included to use the features of this extension. namespace glm { namespace detail diff --git a/glm/gtx/normalize_dot.hpp b/glm/gtx/normalize_dot.hpp index 51958023..127aa1f6 100644 --- a/glm/gtx/normalize_dot.hpp +++ b/glm/gtx/normalize_dot.hpp @@ -7,7 +7,7 @@ /// @defgroup gtx_normalize_dot GLM_GTX_normalize_dot /// @ingroup gtx /// -/// Include to use the features of this extension. +/// Include to use the features of this extension. /// /// Dot product of vectors that need to be normalize with a single square root. diff --git a/glm/gtx/pca.hpp b/glm/gtx/pca.hpp index 93da745e..1a83fdad 100644 --- a/glm/gtx/pca.hpp +++ b/glm/gtx/pca.hpp @@ -33,7 +33,7 @@ /// /// glm::sortEigenvalues(evals, evecs); /// -/// // ... now evecs[0] points in the direction (symmetric) of the largest spatial distribuion within ptData +/// // ... now evecs[0] points in the direction (symmetric) of the largest spatial distribution within ptData /// ``` #pragma once @@ -57,11 +57,14 @@ namespace glm { /// Compute a covariance matrix form an array of relative coordinates `v` (e.g., relative to the center of gravity of the object) /// @param v Points to a memory holding `n` times vectors + /// @param n Number of points in v template GLM_INLINE mat computeCovarianceMatrix(vec const* v, size_t n); /// Compute a covariance matrix form an array of absolute coordinates `v` and a precomputed center of gravity `c` /// @param v Points to a memory holding `n` times vectors + /// @param n Number of points in v + /// @param c Precomputed center of gravity template GLM_INLINE mat computeCovarianceMatrix(vec const* v, size_t n, vec const& c); @@ -78,9 +81,10 @@ namespace glm { /// Assuming the provided covariance matrix `covarMat` is symmetric and real-valued, this function find the `D` Eigenvalues of the matrix, and also provides the corresponding Eigenvectors. /// Note: the data in `outEigenvalues` and `outEigenvectors` are in matching order, i.e. `outEigenvector[i]` is the Eigenvector of the Eigenvalue `outEigenvalue[i]`. /// This is a numeric implementation to find the Eigenvalues, using 'QL decomposition` (variant of QR decomposition: https://en.wikipedia.org/wiki/QR_decomposition). - /// @param covarMat A symmetric, real-valued covariance matrix, e.g. computed from `computeCovarianceMatrix`. - /// @param outEigenvalues Vector to receive the found eigenvalues - /// @param outEigenvectors Matrix to receive the found eigenvectors corresponding to the found eigenvalues, as column vectors + /// + /// @param[in] covarMat A symmetric, real-valued covariance matrix, e.g. computed from computeCovarianceMatrix + /// @param[out] outEigenvalues Vector to receive the found eigenvalues + /// @param[out] outEigenvectors Matrix to receive the found eigenvectors corresponding to the found eigenvalues, as column vectors /// @return The number of eigenvalues found, usually D if the precondition of the covariance matrix is met. template GLM_FUNC_DECL unsigned int findEigenvaluesSymReal diff --git a/glm/gtx/quaternion.hpp b/glm/gtx/quaternion.hpp index 5c2b5ad0..481cab00 100644 --- a/glm/gtx/quaternion.hpp +++ b/glm/gtx/quaternion.hpp @@ -9,7 +9,7 @@ /// /// Include to use the features of this extension. /// -/// Extented quaternion types and functions +/// Extended quaternion types and functions #pragma once diff --git a/glm/gtx/scalar_multiplication.hpp b/glm/gtx/scalar_multiplication.hpp index 496ba193..9f9f2fb3 100644 --- a/glm/gtx/scalar_multiplication.hpp +++ b/glm/gtx/scalar_multiplication.hpp @@ -1,7 +1,10 @@ -/// @ref gtx +/// @ref gtx_scalar_multiplication /// @file glm/gtx/scalar_multiplication.hpp /// @author Joshua Moerman /// +/// @defgroup gtx_scalar_multiplication GLM_GTX_scalar_multiplication +/// @ingroup gtx +/// /// Include to use the features of this extension. /// /// Enables scalar multiplication for all types @@ -32,6 +35,9 @@ namespace glm { + /// @addtogroup gtx_scalar_multiplication + /// @{ + template using return_type_scalar_multiplication = typename std::enable_if< !std::is_same::value // T may not be a float @@ -72,4 +78,5 @@ GLM_IMPLEMENT_SCAL_MULT(mat4x3) GLM_IMPLEMENT_SCAL_MULT(mat4) #undef GLM_IMPLEMENT_SCAL_MULT + /// @} } // namespace glm diff --git a/glm/gtx/vec_swizzle.hpp b/glm/gtx/vec_swizzle.hpp index 1c49abcb..f9e36f3e 100644 --- a/glm/gtx/vec_swizzle.hpp +++ b/glm/gtx/vec_swizzle.hpp @@ -23,6 +23,9 @@ #endif namespace glm { + /// @addtogroup gtx_vec_swizzle + /// @{ + // xx template GLM_INLINE glm::vec<2, T, Q> xx(const glm::vec<1, T, Q> &v) { @@ -2779,4 +2782,5 @@ namespace glm { return glm::vec<4, T, Q>(v.w, v.w, v.w, v.w); } -} + /// @} +}//namespace glm diff --git a/glm/gtx/vector_query.hpp b/glm/gtx/vector_query.hpp index 77c7b974..af1f7b9b 100644 --- a/glm/gtx/vector_query.hpp +++ b/glm/gtx/vector_query.hpp @@ -8,7 +8,7 @@ /// /// Include to use the features of this extension. /// -/// Query informations of vector types +/// Query information of vector types #pragma once