Browse Source

Improved doxygen doc

Christophe Riccio 7 years ago
parent
commit
45d7fc8c4e

+ 2 - 2
glm/exponential.hpp

@@ -6,9 +6,9 @@
 /// @defgroup core_func_exponential Exponential functions
 /// @ingroup core
 ///
-/// Include <glm/exponential.hpp> to use these core features.
-///
 /// These all operate component-wise. The description is per component.
+///
+/// Include <glm/exponential.hpp> to use these core features.
 
 #pragma once
 

+ 3 - 0
glm/ext/matrix_clip_space.hpp

@@ -13,6 +13,9 @@
 /// specifications defines the particular layout of this eye space.
 ///
 /// Include <glm/ext/matrix_clip_space.hpp> to use the features of this extension.
+///
+/// @see ext_matrix_transform
+/// @see ext_matrix_projection
 
 #pragma once
 

+ 3 - 0
glm/ext/matrix_projection.hpp

@@ -13,6 +13,9 @@
 /// specifications defines the particular layout of this eye space.
 ///
 /// Include <glm/ext/matrix_projection.hpp> to use the features of this extension.
+///
+/// @see ext_matrix_transform
+/// @see ext_matrix_clip_space
 
 #pragma once
 

+ 4 - 0
glm/ext/matrix_relational.hpp

@@ -7,6 +7,10 @@
 /// Comparison functions for a user defined epsilon values.
 ///
 /// Include <glm/ext/matrix_relational.hpp> to use the features of this extension.
+///
+/// @see ext_vector_relational
+/// @see ext_scalar_relational
+/// @see ext_quaternion_relational
 
 #pragma once
 

+ 3 - 0
glm/ext/matrix_transform.hpp

@@ -13,6 +13,9 @@
 /// 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.
+///
+/// @see ext_matrix_projection
+/// @see ext_matrix_clip_space
 
 #pragma once
 

+ 11 - 1
glm/ext/quaternion_common.hpp

@@ -4,9 +4,19 @@
 /// @defgroup ext_quaternion_common GLM_EXT_quaternion_common
 /// @ingroup ext
 ///
+/// Defines a templated quaternion type and several quaternion operations.
+///
 /// Include <glm/ext/quaternion_common.hpp> to use the features of this extension.
 ///
-/// Defines a templated quaternion type and several quaternion operations.
+/// @see ext_scalar_common
+/// @see ext_vector_common
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
+/// @see ext_quaternion_exponential
+/// @see ext_quaternion_geometric
+/// @see ext_quaternion_relational
+/// @see ext_quaternion_trigonometric
+/// @see ext_quaternion_transform
 
 #pragma once
 

+ 6 - 0
glm/ext/quaternion_double.hpp

@@ -10,6 +10,12 @@
 ///
 /// @see ext_quaternion_float
 /// @see ext_quaternion_double_precision
+/// @see ext_quaternion_common
+/// @see ext_quaternion_exponential
+/// @see ext_quaternion_geometric
+/// @see ext_quaternion_relational
+/// @see ext_quaternion_transform
+/// @see ext_quaternion_trigonometric
 
 #pragma once
 

+ 5 - 1
glm/ext/quaternion_exponential.hpp

@@ -4,9 +4,13 @@
 /// @defgroup ext_quaternion_exponential GLM_EXT_quaternion_exponential
 /// @ingroup ext
 ///
+/// Defines a templated quaternion type and several quaternion operations.
+///
 /// Include <glm/ext/quaternion_exponential.hpp> to use the features of this extension.
 ///
-/// Defines a templated quaternion type and several quaternion operations.
+/// @see core_exponential
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
 
 #pragma once
 

+ 6 - 0
glm/ext/quaternion_float.hpp

@@ -10,6 +10,12 @@
 ///
 /// @see ext_quaternion_double
 /// @see ext_quaternion_float_precision
+/// @see ext_quaternion_common
+/// @see ext_quaternion_exponential
+/// @see ext_quaternion_geometric
+/// @see ext_quaternion_relational
+/// @see ext_quaternion_transform
+/// @see ext_quaternion_trigonometric
 
 #pragma once
 

+ 4 - 0
glm/ext/quaternion_geometric.hpp

@@ -7,6 +7,10 @@
 /// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
 ///
 /// Defines a templated quaternion type and several quaternion operations.
+///
+/// @see core_geometric
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
 
 #pragma once
 

+ 6 - 0
glm/ext/quaternion_relational.hpp

@@ -7,6 +7,12 @@
 /// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
 ///
 /// Defines a templated quaternion type and several quaternion operations.
+///
+/// @see core_vector_relational
+/// @see ext_vector_relational
+/// @see ext_matrix_relational
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
 
 #pragma once
 

+ 7 - 0
glm/ext/quaternion_transform.hpp

@@ -7,6 +7,13 @@
 /// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
 ///
 /// Defines a templated quaternion type and several quaternion operations.
+///
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
+/// @see ext_quaternion_exponential
+/// @see ext_quaternion_geometric
+/// @see ext_quaternion_relational
+/// @see ext_quaternion_trigonometric
 
 #pragma once
 

+ 7 - 0
glm/ext/quaternion_trigonometric.hpp

@@ -7,6 +7,13 @@
 /// Include <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
 ///
 /// Defines a templated quaternion type and several quaternion operations.
+///
+/// @see ext_quaternion_float
+/// @see ext_quaternion_double
+/// @see ext_quaternion_exponential
+/// @see ext_quaternion_geometric
+/// @see ext_quaternion_relational
+/// @see ext_quaternion_transform
 
 #pragma once
 

+ 5 - 1
glm/ext/scalar_relational.hpp

@@ -4,9 +4,13 @@
 /// @defgroup ext_scalar_relational GLM_EXT_scalar_relational
 /// @ingroup ext
 ///
+/// Comparison functions for a user defined epsilon values.
+///
 /// Include <glm/ext/scalar_relational.hpp> to use the features of this extension.
 ///
-/// Comparison functions for a user defined epsilon values.
+/// @see core_vector_relational
+/// @see ext_vector_relational
+/// @see ext_matrix_relational
 
 #pragma once
 

+ 1 - 0
glm/ext/vector_relational.hpp

@@ -10,6 +10,7 @@
 ///
 /// @see core_vector_relational
 /// @see ext_scalar_relational
+/// @see ext_matrix_relational
 
 #pragma once
 

+ 2 - 2
glm/geometric.hpp

@@ -6,9 +6,9 @@
 /// @defgroup core_func_geometric Geometric functions
 /// @ingroup core
 ///
-/// Include <glm/geometric.hpp> to use these core features.
-///
 /// These operate on vectors as vectors, not component-wise.
+///
+/// Include <glm/geometric.hpp> to use these core features.
 
 #pragma once
 

+ 4 - 2
glm/trigonometric.hpp

@@ -6,13 +6,15 @@
 /// @defgroup core_func_trigonometric Angle and Trigonometry Functions
 /// @ingroup core
 ///
-/// Include <glm/trigonometric.hpp> to use these core features.
-///
 /// Function parameters specified as angle are assumed to be in units of radians.
 /// In no case will any of these functions result in a divide by zero error. If
 /// the divisor of a ratio is 0, then results will be undefined.
 ///
 /// These all operate component-wise. The description is per component.
+///
+/// Include <glm/trigonometric.hpp> to use these core features.
+///
+/// @see ext_vector_trigonometric
 
 #pragma once
 

+ 4 - 2
glm/vector_relational.hpp

@@ -6,14 +6,16 @@
 /// @defgroup core_func_vector_relational Vector Relational Functions
 /// @ingroup core
 ///
-/// Include <glm/vector_relational.hpp> to use these core features.
-///
 /// Relational and equality operators (<, <=, >, >=, ==, !=) are defined to
 /// operate on scalars and produce scalar Boolean results. For vector results,
 /// use the following built-in functions.
 ///
 /// In all cases, the sizes of all the input and return vectors for any particular
 /// call must match.
+///
+/// Include <glm/vector_relational.hpp> to use these core features.
+///
+/// @see ext_vector_relational
 
 #pragma once