diff --git a/glm/common.hpp b/glm/common.hpp index 66ad8614..4ab34bd1 100644 --- a/glm/common.hpp +++ b/glm/common.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_common Common functions /// @ingroup core /// +/// Provide GLSL common functions +/// /// These all operate component-wise. The description is per component. /// /// Include to use these core features. diff --git a/glm/exponential.hpp b/glm/exponential.hpp index d88fc5c2..9ae6806e 100644 --- a/glm/exponential.hpp +++ b/glm/exponential.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_exponential Exponential functions /// @ingroup core /// +/// Provide GLSL exponential functions +/// /// These all operate component-wise. The description is per component. /// /// Include to use these core features. diff --git a/glm/ext/matrix_relational.hpp b/glm/ext/matrix_relational.hpp index 0681125e..beddec2e 100644 --- a/glm/ext/matrix_relational.hpp +++ b/glm/ext/matrix_relational.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_matrix_relational GLM_EXT_matrix_relational /// @ingroup ext /// -/// Comparison functions for a user defined epsilon values. +/// Exposes comparison functions for matrix types that take a user defined epsilon values. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_common.hpp b/glm/ext/quaternion_common.hpp index c1e6df83..2980ed4d 100644 --- a/glm/ext/quaternion_common.hpp +++ b/glm/ext/quaternion_common.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_common GLM_EXT_quaternion_common /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Provides common functions for quaternion types /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_double.hpp b/glm/ext/quaternion_double.hpp index 7a6aa2d7..63b24de4 100644 --- a/glm/ext/quaternion_double.hpp +++ b/glm/ext/quaternion_double.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_double GLM_EXT_quaternion_double /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Exposes double-precision floating point quaternion type. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_double_precision.hpp b/glm/ext/quaternion_double_precision.hpp index 0cd8367e..8aa24a17 100644 --- a/glm/ext/quaternion_double_precision.hpp +++ b/glm/ext/quaternion_double_precision.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_double_precision GLM_EXT_quaternion_double_precision /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Exposes double-precision floating point quaternion type with various precision in term of ULPs. /// /// Include to use the features of this extension. diff --git a/glm/ext/quaternion_exponential.hpp b/glm/ext/quaternion_exponential.hpp index 22002f9e..affe2979 100644 --- a/glm/ext/quaternion_exponential.hpp +++ b/glm/ext/quaternion_exponential.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_exponential GLM_EXT_quaternion_exponential /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Provides exponential functions for quaternion types /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_float.hpp b/glm/ext/quaternion_float.hpp index 4ba7eace..ca42a605 100644 --- a/glm/ext/quaternion_float.hpp +++ b/glm/ext/quaternion_float.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_float GLM_EXT_quaternion_float /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Exposes single-precision floating point quaternion type. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_float_precision.hpp b/glm/ext/quaternion_float_precision.hpp index 53dfcedb..f9e4f5c2 100644 --- a/glm/ext/quaternion_float_precision.hpp +++ b/glm/ext/quaternion_float_precision.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_float_precision GLM_EXT_quaternion_float_precision /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Exposes single-precision floating point quaternion type with various precision in term of ULPs. /// /// Include to use the features of this extension. diff --git a/glm/ext/quaternion_geometric.hpp b/glm/ext/quaternion_geometric.hpp index bfa29117..6d98bbe9 100644 --- a/glm/ext/quaternion_geometric.hpp +++ b/glm/ext/quaternion_geometric.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_geometric GLM_EXT_quaternion_geometric /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Provides geometric functions for quaternion types /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_relational.hpp b/glm/ext/quaternion_relational.hpp index d9e308de..7aa121da 100644 --- a/glm/ext/quaternion_relational.hpp +++ b/glm/ext/quaternion_relational.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_relational GLM_EXT_quaternion_relational /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Exposes comparison functions for quaternion types that take a user defined epsilon values. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_transform.hpp b/glm/ext/quaternion_transform.hpp index 975bca8b..a9cc5c2b 100644 --- a/glm/ext/quaternion_transform.hpp +++ b/glm/ext/quaternion_transform.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_transform GLM_EXT_quaternion_transform /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Provides transformation functions for quaternion types /// /// Include to use the features of this extension. /// diff --git a/glm/ext/quaternion_trigonometric.hpp b/glm/ext/quaternion_trigonometric.hpp index 391d862b..76cea27a 100644 --- a/glm/ext/quaternion_trigonometric.hpp +++ b/glm/ext/quaternion_trigonometric.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_quaternion_trigonometric GLM_EXT_quaternion_trigonometric /// @ingroup ext /// -/// Defines a templated quaternion type and several quaternion operations. +/// Provides trigonometric functions for quaternion types /// /// Include to use the features of this extension. /// diff --git a/glm/ext/scalar_common.hpp b/glm/ext/scalar_common.hpp index 3f1bdc19..4ab0f88b 100644 --- a/glm/ext/scalar_common.hpp +++ b/glm/ext/scalar_common.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_scalar_common GLM_EXT_scalar_common /// @ingroup ext /// -/// Min and max functions for 3 to 4 scalar parameters. +/// Exposes min and max functions for 3 to 4 scalar parameters. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/scalar_constants.hpp b/glm/ext/scalar_constants.hpp index 1574465c..4a61faa5 100644 --- a/glm/ext/scalar_constants.hpp +++ b/glm/ext/scalar_constants.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_scalar_constants GLM_EXT_scalar_constants /// @ingroup ext /// -/// Provide a list of constants and precomputed useful values. +/// Provides a list of constants and precomputed useful values. /// /// Include to use the features of this extension. diff --git a/glm/ext/scalar_relational.hpp b/glm/ext/scalar_relational.hpp index b1273547..6b7fd773 100644 --- a/glm/ext/scalar_relational.hpp +++ b/glm/ext/scalar_relational.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_scalar_relational GLM_EXT_scalar_relational /// @ingroup ext /// -/// Comparison functions for a user defined epsilon values. +/// Exposes comparison functions for scalar types that take a user defined epsilon values. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/vector_common.hpp b/glm/ext/vector_common.hpp index 88cf271d..324fe1c7 100644 --- a/glm/ext/vector_common.hpp +++ b/glm/ext/vector_common.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_vector_common GLM_EXT_vector_common /// @ingroup ext /// -/// Min and max functions for 3 to 4 parameters. +/// Exposes min and max functions for 3 to 4 vector parameters. /// /// Include to use the features of this extension. /// diff --git a/glm/ext/vector_relational.hpp b/glm/ext/vector_relational.hpp index bf644159..a7f93d23 100644 --- a/glm/ext/vector_relational.hpp +++ b/glm/ext/vector_relational.hpp @@ -4,7 +4,7 @@ /// @defgroup ext_vector_relational GLM_EXT_vector_relational /// @ingroup ext /// -/// Comparison functions for a user defined epsilon values. +/// Exposes comparison functions for vector types that take a user defined epsilon values. /// /// Include to use the features of this extension. /// diff --git a/glm/integer.hpp b/glm/integer.hpp index 450809bc..f0a48f9f 100644 --- a/glm/integer.hpp +++ b/glm/integer.hpp @@ -6,6 +6,8 @@ /// @defgroup core_func_integer Integer functions /// @ingroup core /// +/// Provide GLSL functions on integer types +/// /// These all operate component-wise. The description is per component. /// The notation [a, b] means the set of bits from bit-number a through bit-number /// b, inclusive. The lowest-order bit is bit 0. diff --git a/glm/matrix.hpp b/glm/matrix.hpp index fb7efce2..208a0849 100644 --- a/glm/matrix.hpp +++ b/glm/matrix.hpp @@ -6,11 +6,7 @@ /// @defgroup core_func_matrix Matrix functions /// @ingroup core /// -/// For each of the following built-in matrix functions, there is both a -/// single-qualifier floating point version, where all arguments and return values -/// are single qualifier, and a double-qualifier floating version, where all -/// arguments and return values are double qualifier. Only the single-qualifier -/// floating point version is shown. +/// Provide GLSL matrix functions. /// /// Include to use these core features. diff --git a/glm/packing.hpp b/glm/packing.hpp index d493ff9d..56174a6a 100644 --- a/glm/packing.hpp +++ b/glm/packing.hpp @@ -7,6 +7,8 @@ /// @defgroup core_func_packing Floating-Point Pack and Unpack Functions /// @ingroup core /// +/// Provide GLSL functions to pack and unpack half, single and double-precision floating point values into more compact integer types. +/// /// These functions do not operate component-wise, rather as described in each case. /// /// Include to use these core features.