From 45d7fc8c4e5c2e53fea75e34f548080c6d521805 Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Wed, 29 Aug 2018 14:28:01 +0200 Subject: [PATCH] Improved doxygen doc --- glm/exponential.hpp | 4 ++-- glm/ext/matrix_clip_space.hpp | 3 +++ glm/ext/matrix_projection.hpp | 3 +++ glm/ext/matrix_relational.hpp | 4 ++++ glm/ext/matrix_transform.hpp | 3 +++ glm/ext/quaternion_common.hpp | 12 +++++++++++- glm/ext/quaternion_double.hpp | 6 ++++++ glm/ext/quaternion_exponential.hpp | 6 +++++- glm/ext/quaternion_float.hpp | 6 ++++++ glm/ext/quaternion_geometric.hpp | 4 ++++ glm/ext/quaternion_relational.hpp | 6 ++++++ glm/ext/quaternion_transform.hpp | 7 +++++++ glm/ext/quaternion_trigonometric.hpp | 7 +++++++ glm/ext/scalar_relational.hpp | 6 +++++- glm/ext/vector_relational.hpp | 1 + glm/geometric.hpp | 4 ++-- glm/trigonometric.hpp | 6 ++++-- glm/vector_relational.hpp | 6 ++++-- 18 files changed, 83 insertions(+), 11 deletions(-) diff --git a/glm/exponential.hpp b/glm/exponential.hpp index 8fac30ee..d88fc5c2 100644 --- a/glm/exponential.hpp +++ b/glm/exponential.hpp @@ -6,9 +6,9 @@ /// @defgroup core_func_exponential Exponential functions /// @ingroup core /// -/// Include to use these core features. -/// /// These all operate component-wise. The description is per component. +/// +/// Include to use these core features. #pragma once diff --git a/glm/ext/matrix_clip_space.hpp b/glm/ext/matrix_clip_space.hpp index 7a262f34..474ee55b 100644 --- a/glm/ext/matrix_clip_space.hpp +++ b/glm/ext/matrix_clip_space.hpp @@ -13,6 +13,9 @@ /// specifications defines the particular layout of this eye space. /// /// Include to use the features of this extension. +/// +/// @see ext_matrix_transform +/// @see ext_matrix_projection #pragma once diff --git a/glm/ext/matrix_projection.hpp b/glm/ext/matrix_projection.hpp index 47baa3ee..51fd01bd 100644 --- a/glm/ext/matrix_projection.hpp +++ b/glm/ext/matrix_projection.hpp @@ -13,6 +13,9 @@ /// specifications defines the particular layout of this eye space. /// /// Include to use the features of this extension. +/// +/// @see ext_matrix_transform +/// @see ext_matrix_clip_space #pragma once diff --git a/glm/ext/matrix_relational.hpp b/glm/ext/matrix_relational.hpp index e16104ea..0681125e 100644 --- a/glm/ext/matrix_relational.hpp +++ b/glm/ext/matrix_relational.hpp @@ -7,6 +7,10 @@ /// Comparison functions for a user defined epsilon values. /// /// Include to use the features of this extension. +/// +/// @see ext_vector_relational +/// @see ext_scalar_relational +/// @see ext_quaternion_relational #pragma once diff --git a/glm/ext/matrix_transform.hpp b/glm/ext/matrix_transform.hpp index 7f584d88..5478c2d9 100644 --- a/glm/ext/matrix_transform.hpp +++ b/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 diff --git a/glm/ext/quaternion_common.hpp b/glm/ext/quaternion_common.hpp index eb9b742a..c1e6df83 100644 --- a/glm/ext/quaternion_common.hpp +++ b/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 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 diff --git a/glm/ext/quaternion_double.hpp b/glm/ext/quaternion_double.hpp index f0a056c2..7a6aa2d7 100644 --- a/glm/ext/quaternion_double.hpp +++ b/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 diff --git a/glm/ext/quaternion_exponential.hpp b/glm/ext/quaternion_exponential.hpp index be877687..22002f9e 100644 --- a/glm/ext/quaternion_exponential.hpp +++ b/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 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 diff --git a/glm/ext/quaternion_float.hpp b/glm/ext/quaternion_float.hpp index 5b094258..4ba7eace 100644 --- a/glm/ext/quaternion_float.hpp +++ b/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 diff --git a/glm/ext/quaternion_geometric.hpp b/glm/ext/quaternion_geometric.hpp index cbab2140..fed31348 100644 --- a/glm/ext/quaternion_geometric.hpp +++ b/glm/ext/quaternion_geometric.hpp @@ -7,6 +7,10 @@ /// Include 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 diff --git a/glm/ext/quaternion_relational.hpp b/glm/ext/quaternion_relational.hpp index 3c327838..ac3e9ea0 100644 --- a/glm/ext/quaternion_relational.hpp +++ b/glm/ext/quaternion_relational.hpp @@ -7,6 +7,12 @@ /// Include 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 diff --git a/glm/ext/quaternion_transform.hpp b/glm/ext/quaternion_transform.hpp index 64a128f9..d6640c6f 100644 --- a/glm/ext/quaternion_transform.hpp +++ b/glm/ext/quaternion_transform.hpp @@ -7,6 +7,13 @@ /// Include 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 diff --git a/glm/ext/quaternion_trigonometric.hpp b/glm/ext/quaternion_trigonometric.hpp index f0776e37..ef0fb585 100644 --- a/glm/ext/quaternion_trigonometric.hpp +++ b/glm/ext/quaternion_trigonometric.hpp @@ -7,6 +7,13 @@ /// Include 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 diff --git a/glm/ext/scalar_relational.hpp b/glm/ext/scalar_relational.hpp index c7299aaa..b1273547 100644 --- a/glm/ext/scalar_relational.hpp +++ b/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 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 diff --git a/glm/ext/vector_relational.hpp b/glm/ext/vector_relational.hpp index 1f5fd055..bf644159 100644 --- a/glm/ext/vector_relational.hpp +++ b/glm/ext/vector_relational.hpp @@ -10,6 +10,7 @@ /// /// @see core_vector_relational /// @see ext_scalar_relational +/// @see ext_matrix_relational #pragma once diff --git a/glm/geometric.hpp b/glm/geometric.hpp index e0380830..c068a3cb 100644 --- a/glm/geometric.hpp +++ b/glm/geometric.hpp @@ -6,9 +6,9 @@ /// @defgroup core_func_geometric Geometric functions /// @ingroup core /// -/// Include to use these core features. -/// /// These operate on vectors as vectors, not component-wise. +/// +/// Include to use these core features. #pragma once diff --git a/glm/trigonometric.hpp b/glm/trigonometric.hpp index 15caadb6..fcf07f89 100644 --- a/glm/trigonometric.hpp +++ b/glm/trigonometric.hpp @@ -6,13 +6,15 @@ /// @defgroup core_func_trigonometric Angle and Trigonometry Functions /// @ingroup core /// -/// Include 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 to use these core features. +/// +/// @see ext_vector_trigonometric #pragma once diff --git a/glm/vector_relational.hpp b/glm/vector_relational.hpp index 2c411b8e..a0fe17eb 100644 --- a/glm/vector_relational.hpp +++ b/glm/vector_relational.hpp @@ -6,14 +6,16 @@ /// @defgroup core_func_vector_relational Vector Relational Functions /// @ingroup core /// -/// Include 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 to use these core features. +/// +/// @see ext_vector_relational #pragma once