mirror of
https://github.com/g-truc/glm.git
synced 2024-12-01 20:24:38 +00:00
Improved doxygen doc
This commit is contained in:
parent
a0c47aced6
commit
45d7fc8c4e
@ -6,9 +6,9 @@
|
|||||||
/// @defgroup core_func_exponential Exponential functions
|
/// @defgroup core_func_exponential Exponential functions
|
||||||
/// @ingroup core
|
/// @ingroup core
|
||||||
///
|
///
|
||||||
/// Include <glm/exponential.hpp> to use these core features.
|
|
||||||
///
|
|
||||||
/// These all operate component-wise. The description is per component.
|
/// These all operate component-wise. The description is per component.
|
||||||
|
///
|
||||||
|
/// Include <glm/exponential.hpp> to use these core features.
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -13,6 +13,9 @@
|
|||||||
/// specifications defines the particular layout of this eye space.
|
/// specifications defines the particular layout of this eye space.
|
||||||
///
|
///
|
||||||
/// Include <glm/ext/matrix_clip_space.hpp> to use the features of this extension.
|
/// Include <glm/ext/matrix_clip_space.hpp> to use the features of this extension.
|
||||||
|
///
|
||||||
|
/// @see ext_matrix_transform
|
||||||
|
/// @see ext_matrix_projection
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -13,6 +13,9 @@
|
|||||||
/// specifications defines the particular layout of this eye space.
|
/// specifications defines the particular layout of this eye space.
|
||||||
///
|
///
|
||||||
/// Include <glm/ext/matrix_projection.hpp> to use the features of this extension.
|
/// Include <glm/ext/matrix_projection.hpp> to use the features of this extension.
|
||||||
|
///
|
||||||
|
/// @see ext_matrix_transform
|
||||||
|
/// @see ext_matrix_clip_space
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -7,6 +7,10 @@
|
|||||||
/// Comparison functions for a user defined epsilon values.
|
/// Comparison functions for a user defined epsilon values.
|
||||||
///
|
///
|
||||||
/// Include <glm/ext/matrix_relational.hpp> to use the features of this extension.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -13,6 +13,9 @@
|
|||||||
/// space into the specific eye space that the projective matrix functions
|
/// space into the specific eye space that the projective matrix functions
|
||||||
/// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility
|
/// (perspective, ortho, etc) are designed to expect. The OpenGL compatibility
|
||||||
/// specifications defines the particular layout of this eye space.
|
/// specifications defines the particular layout of this eye space.
|
||||||
|
///
|
||||||
|
/// @see ext_matrix_projection
|
||||||
|
/// @see ext_matrix_clip_space
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -4,9 +4,19 @@
|
|||||||
/// @defgroup ext_quaternion_common GLM_EXT_quaternion_common
|
/// @defgroup ext_quaternion_common GLM_EXT_quaternion_common
|
||||||
/// @ingroup ext
|
/// @ingroup ext
|
||||||
///
|
///
|
||||||
|
/// Defines a templated quaternion type and several quaternion operations.
|
||||||
|
///
|
||||||
/// Include <glm/ext/quaternion_common.hpp> to use the features of this extension.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -10,6 +10,12 @@
|
|||||||
///
|
///
|
||||||
/// @see ext_quaternion_float
|
/// @see ext_quaternion_float
|
||||||
/// @see ext_quaternion_double_precision
|
/// @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
|
#pragma once
|
||||||
|
|
||||||
|
@ -4,9 +4,13 @@
|
|||||||
/// @defgroup ext_quaternion_exponential GLM_EXT_quaternion_exponential
|
/// @defgroup ext_quaternion_exponential GLM_EXT_quaternion_exponential
|
||||||
/// @ingroup ext
|
/// @ingroup ext
|
||||||
///
|
///
|
||||||
|
/// Defines a templated quaternion type and several quaternion operations.
|
||||||
|
///
|
||||||
/// Include <glm/ext/quaternion_exponential.hpp> to use the features of this extension.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -10,6 +10,12 @@
|
|||||||
///
|
///
|
||||||
/// @see ext_quaternion_double
|
/// @see ext_quaternion_double
|
||||||
/// @see ext_quaternion_float_precision
|
/// @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
|
#pragma once
|
||||||
|
|
||||||
|
@ -7,6 +7,10 @@
|
|||||||
/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
|
/// Include <glm/ext/quaternion_geometric.hpp> to use the features of this extension.
|
||||||
///
|
///
|
||||||
/// Defines a templated quaternion type and several quaternion operations.
|
/// Defines a templated quaternion type and several quaternion operations.
|
||||||
|
///
|
||||||
|
/// @see core_geometric
|
||||||
|
/// @see ext_quaternion_float
|
||||||
|
/// @see ext_quaternion_double
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -7,6 +7,12 @@
|
|||||||
/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
|
/// Include <glm/ext/quaternion_relational.hpp> to use the features of this extension.
|
||||||
///
|
///
|
||||||
/// Defines a templated quaternion type and several quaternion operations.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -7,6 +7,13 @@
|
|||||||
/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
|
/// Include <glm/ext/quaternion_transform.hpp> to use the features of this extension.
|
||||||
///
|
///
|
||||||
/// Defines a templated quaternion type and several quaternion operations.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -7,6 +7,13 @@
|
|||||||
/// Include <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
|
/// Include <glm/ext/quaternion_trigonometric.hpp> to use the features of this extension.
|
||||||
///
|
///
|
||||||
/// Defines a templated quaternion type and several quaternion operations.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -4,9 +4,13 @@
|
|||||||
/// @defgroup ext_scalar_relational GLM_EXT_scalar_relational
|
/// @defgroup ext_scalar_relational GLM_EXT_scalar_relational
|
||||||
/// @ingroup ext
|
/// @ingroup ext
|
||||||
///
|
///
|
||||||
|
/// Comparison functions for a user defined epsilon values.
|
||||||
|
///
|
||||||
/// Include <glm/ext/scalar_relational.hpp> to use the features of this extension.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -10,6 +10,7 @@
|
|||||||
///
|
///
|
||||||
/// @see core_vector_relational
|
/// @see core_vector_relational
|
||||||
/// @see ext_scalar_relational
|
/// @see ext_scalar_relational
|
||||||
|
/// @see ext_matrix_relational
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -6,9 +6,9 @@
|
|||||||
/// @defgroup core_func_geometric Geometric functions
|
/// @defgroup core_func_geometric Geometric functions
|
||||||
/// @ingroup core
|
/// @ingroup core
|
||||||
///
|
///
|
||||||
/// Include <glm/geometric.hpp> to use these core features.
|
|
||||||
///
|
|
||||||
/// These operate on vectors as vectors, not component-wise.
|
/// These operate on vectors as vectors, not component-wise.
|
||||||
|
///
|
||||||
|
/// Include <glm/geometric.hpp> to use these core features.
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
@ -6,13 +6,15 @@
|
|||||||
/// @defgroup core_func_trigonometric Angle and Trigonometry Functions
|
/// @defgroup core_func_trigonometric Angle and Trigonometry Functions
|
||||||
/// @ingroup core
|
/// @ingroup core
|
||||||
///
|
///
|
||||||
/// Include <glm/trigonometric.hpp> to use these core features.
|
|
||||||
///
|
|
||||||
/// Function parameters specified as angle are assumed to be in units of radians.
|
/// 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
|
/// 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.
|
/// the divisor of a ratio is 0, then results will be undefined.
|
||||||
///
|
///
|
||||||
/// These all operate component-wise. The description is per component.
|
/// 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
|
#pragma once
|
||||||
|
|
||||||
|
@ -6,14 +6,16 @@
|
|||||||
/// @defgroup core_func_vector_relational Vector Relational Functions
|
/// @defgroup core_func_vector_relational Vector Relational Functions
|
||||||
/// @ingroup core
|
/// @ingroup core
|
||||||
///
|
///
|
||||||
/// Include <glm/vector_relational.hpp> to use these core features.
|
|
||||||
///
|
|
||||||
/// Relational and equality operators (<, <=, >, >=, ==, !=) are defined to
|
/// Relational and equality operators (<, <=, >, >=, ==, !=) are defined to
|
||||||
/// operate on scalars and produce scalar Boolean results. For vector results,
|
/// operate on scalars and produce scalar Boolean results. For vector results,
|
||||||
/// use the following built-in functions.
|
/// use the following built-in functions.
|
||||||
///
|
///
|
||||||
/// In all cases, the sizes of all the input and return vectors for any particular
|
/// In all cases, the sizes of all the input and return vectors for any particular
|
||||||
/// call must match.
|
/// call must match.
|
||||||
|
///
|
||||||
|
/// Include <glm/vector_relational.hpp> to use these core features.
|
||||||
|
///
|
||||||
|
/// @see ext_vector_relational
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user