Improved doxygen API doc

adiog · Aug 31, 2018 · 0b974f0 · 0b974f0
1 parent f6be32e
commit 0b974f0
Show file tree

Hide file tree

Showing 80 changed files with 125 additions and 98 deletions.
diff --git a/glm/common.hpp b/glm/common.hpp
@@ -26,7 +26,6 @@ namespace glm
 	///
 	/// @see <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/abs.xml">GLSL abs man page</a>
 	/// @see <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a>
-	/// @see qualifier
 	template<typename genType>
 	GLM_FUNC_DECL GLM_CONSTEXPR genType abs(genType x);
 

diff --git a/glm/ext/matrix_double2x2.hpp b/glm/ext/matrix_double2x2.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 2 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double2x2_precision.hpp b/glm/ext/matrix_double2x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double2x3.hpp b/glm/ext/matrix_double2x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 3 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double2x3_precision.hpp b/glm/ext/matrix_double2x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double2x4.hpp b/glm/ext/matrix_double2x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 4 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double2x4_precision.hpp b/glm/ext/matrix_double2x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double3x2.hpp b/glm/ext/matrix_double3x2.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 3 columns of 2 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double3x2_precision.hpp b/glm/ext/matrix_double3x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double3x3.hpp b/glm/ext/matrix_double3x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 3 columns of 3 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double3x3_precision.hpp b/glm/ext/matrix_double3x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double3x4.hpp b/glm/ext/matrix_double3x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 3 columns of 4 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double3x4_precision.hpp b/glm/ext/matrix_double3x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double4x2.hpp b/glm/ext/matrix_double4x2.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 4 columns of 2 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double4x2_precision.hpp b/glm/ext/matrix_double4x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 2 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double4x3.hpp b/glm/ext/matrix_double4x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 4 columns of 3 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double4x3_precision.hpp b/glm/ext/matrix_double4x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 3 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_double4x4.hpp b/glm/ext/matrix_double4x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 4 columns of 4 components matrix of double-precision floating-point numbers.

diff --git a/glm/ext/matrix_double4x4_precision.hpp b/glm/ext/matrix_double4x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 4 components matrix of double-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float2x2.hpp b/glm/ext/matrix_float2x2.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 2 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float2x2_precision.hpp b/glm/ext/matrix_float2x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float2x3.hpp b/glm/ext/matrix_float2x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 3 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float2x3_precision.hpp b/glm/ext/matrix_float2x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float2x4.hpp b/glm/ext/matrix_float2x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 2 columns of 4 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float2x4_precision.hpp b/glm/ext/matrix_float2x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 2 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float3x2_precision.hpp b/glm/ext/matrix_float3x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float3x3.hpp b/glm/ext/matrix_float3x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 3 columns of 3 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float3x3_precision.hpp b/glm/ext/matrix_float3x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float3x4.hpp b/glm/ext/matrix_float3x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 3 columns of 4 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float3x4_precision.hpp b/glm/ext/matrix_float3x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 3 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float4x2.hpp b/glm/ext/matrix_float4x2.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 4 columns of 2 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float4x2_precision.hpp b/glm/ext/matrix_float4x2_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 2 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float4x3.hpp b/glm/ext/matrix_float4x3.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core
+	/// @addtogroup core_matrix
 	/// @{
 
 	/// 4 columns of 3 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float4x3_precision.hpp b/glm/ext/matrix_float4x3_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 3 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_float4x4.hpp b/glm/ext/matrix_float4x4.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @ingroup core
+	/// @ingroup core_matrix
 	/// @{
 
 	/// 4 columns of 4 components matrix of single-precision floating-point numbers.

diff --git a/glm/ext/matrix_float4x4_precision.hpp b/glm/ext/matrix_float4x4_precision.hpp
@@ -6,7 +6,7 @@
 
 namespace glm
 {
-	/// @addtogroup core_precision
+	/// @addtogroup core_matrix_precision
 	/// @{
 
 	/// 4 columns of 4 components matrix of single-precision floating-point numbers using low precision arithmetic in term of ULPs.

diff --git a/glm/ext/matrix_transform.hpp b/glm/ext/matrix_transform.hpp
@@ -4,8 +4,6 @@
 /// @defgroup ext_matrix_transform GLM_EXT_matrix_transform
 /// @ingroup ext
 ///
-/// Include <glm/ext/matrix_transform.hpp> 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
@@ -14,6 +12,8 @@
 /// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility
 /// specifications defines the particular layout of this eye space.
 ///
+/// Include <glm/ext/matrix_transform.hpp> to use the features of this extension.
+///
 /// @see ext_matrix_projection
 /// @see ext_matrix_clip_space
 

diff --git a/glm/ext/quaternion_double_precision.hpp b/glm/ext/quaternion_double_precision.hpp
@@ -4,9 +4,9 @@
 /// @defgroup ext_quaternion_double_precision GLM_EXT_quaternion_double_precision
 /// @ingroup ext
 ///
-/// Include <glm/ext/quaternion_double_precision.hpp> to use the features of this extension.
-///
 /// Defines a templated quaternion type and several quaternion operations.
+///
+/// Include <glm/ext/quaternion_double_precision.hpp> to use the features of this extension.
 
 #pragma once
 

diff --git a/glm/ext/quaternion_geometric.hpp b/glm/ext/quaternion_geometric.hpp
@@ -4,10 +4,10 @@
 /// @defgroup ext_quaternion_geometric GLM_EXT_quaternion_geometric
 /// @ingroup ext
 ///
-/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
-///
 /// Defines a templated quaternion type and several quaternion operations.
 ///
+/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
+///
 /// @see core_geometric
 /// @see ext_quaternion_float
 /// @see ext_quaternion_double

diff --git a/glm/ext/quaternion_relational.hpp b/glm/ext/quaternion_relational.hpp
@@ -4,10 +4,10 @@
 /// @defgroup ext_quaternion_relational GLM_EXT_quaternion_relational
 /// @ingroup ext
 ///
-/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
-///
 /// Defines a templated quaternion type and several quaternion operations.
 ///
+/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
+///
 /// @see core_vector_relational
 /// @see ext_vector_relational
 /// @see ext_matrix_relational

diff --git a/glm/ext/quaternion_transform.hpp b/glm/ext/quaternion_transform.hpp
@@ -4,10 +4,10 @@
 /// @defgroup ext_quaternion_transform GLM_EXT_quaternion_transform
 /// @ingroup ext
 ///
-/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
-///
 /// Defines a templated quaternion type and several quaternion operations.
 ///
+/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
+///
 /// @see ext_quaternion_float
 /// @see ext_quaternion_double
 /// @see ext_quaternion_exponential