Updated doxygen API documentation

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 <glm/common.hpp> to use these core features.

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 <glm/exponential.hpp> to use these core features.

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 <glm/ext/matrix_relational.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_common.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_double.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_double_precision.hpp> to use the features of this extension.
 

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 <glm/ext/quaternion_exponential.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_float.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_float_precision.hpp> to use the features of this extension.
 

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 <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_relational.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_transform.hpp> to use the features of this extension.
 ///

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 <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
 ///

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 <glm/ext/scalar_common.hpp> to use the features of this extension.
 ///

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 <glm/ext/scalar_constants.hpp> to use the features of this extension.
 

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 <glm/ext/scalar_relational.hpp> to use the features of this extension.
 ///

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 <glm/ext/vector_common.hpp> to use the features of this extension.
 ///

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 <glm/ext/vector_relational.hpp> to use the features of this extension.
 ///

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.

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 <glm/matrix.hpp> to use these core features.
 

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 <glm/packing.hpp> to use these core features.