Moved docygen documentation to each extension file and added missing extension documentation

This commit is contained in:
Christophe Riccio
2011-06-07 16:37:57 +01:00
parent 3904d5c59c
commit a672f612ad
15 changed files with 191 additions and 174 deletions

View File

@@ -26,6 +26,13 @@
/// @author Christophe Riccio
///
/// @see core (dependence)
///
/// @defgroup gtc_half_float GLM_GTC_half_float: Half-precision floating-point based types and functions
/// @ingroup gtc
///
/// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices.
/// <glm/gtc/half_float.hpp> need to be included to use these functionalities.
///
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_half_float
@@ -344,7 +351,7 @@ namespace detail
namespace gtc
{
/// \addtogroup gtc_half_float
/// @addtogroup gtc_half_float
/// @{
/// Type for half-precision floating-point numbers.

View File

@@ -26,6 +26,12 @@
/// @author Christophe Riccio
///
/// @see core (dependence)
///
/// @defgroup gtc_matrix_access GLM_GTC_matrix_access: Access matrix rows and columns
/// @ingroup gtc
///
/// Defines functions to access rows or columns of a matrix easily.
/// <glm/gtc/matrix_access.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_matrix_access

View File

@@ -26,6 +26,12 @@
/// @author Christophe Riccio
///
/// @see core (dependence)
///
/// @defgroup gtc_matrix_integer GLM_GTC_matrix_integer: Integer matrix types
/// @ingroup gtc
///
/// Defines a number of matrices with integer types.
/// <glm/gtc/matrix_integer.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_matrix_integer

View File

@@ -26,6 +26,12 @@
/// @author Christophe Riccio
///
/// @see core (dependence)
///
/// @defgroup gtc_matrix_inverse GLM_GTC_matrix_inverse: Additional matrix inverse function
/// @ingroup gtc
///
/// Defines additional matrix inverting functions.
/// <glm/gtc/matrix_inverse.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_matrix_inverse
@@ -39,8 +45,8 @@
#endif
namespace glm{
namespace gtc{
namespace gtc
{
/// @addtogroup gtc_matrix_inverse
/// @{

View File

@@ -28,6 +28,19 @@
/// @see core (dependence)
/// @see gtx_transform
/// @see gtx_transform2
///
/// @defgroup gtc_matrix_transform GLM_GTC_matrix_transform: Matrix transform functions
/// @ingroup gtc
///
/// @brief Defines functions that generate common transformation matrices.
///
/// The matrices generated by this extension use standard OpenGL fixed-function
/// conventions. For example, the lookAt function generates a transform from world
/// 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.
///
/// <glm/gtc/matrix_transform.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_matrix_transform
@@ -41,8 +54,8 @@
#endif
namespace glm{
namespace gtc{
namespace gtc
{
/// @addtogroup gtc_matrix_transform
/// @{

View File

@@ -30,6 +30,13 @@
///
/// @todo Study constructors with angles and axis
/// @todo Study constructors with vec3 that are the imaginary component of quaternion
///
/// @defgroup gtc_quaternion GLM_GTC_quaternion: Quaternion types and functions
/// @ingroup gtc
///
/// @brief Defines a templated quaternion type and several quaternion operations.
///
/// <glm/gtc/quaternion.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_quaternion
@@ -46,9 +53,9 @@
namespace glm{
namespace detail
{
/// \brief Template for quaternion.
/// @brief Template for quaternion.
/// From GLM_GTC_quaternion extension.
/// \ingroup gtc_quaternion
/// @ingroup gtc_quaternion
template <typename T>
struct tquat// : public genType<T, tquat>
{

View File

@@ -26,6 +26,13 @@
/// @author Christophe Riccio
///
/// @see core (dependence)
///
/// @defgroup gtc_swizzle GLM_GTC_swizzle: Swizzle 'operator' implementation
/// @ingroup gtc
///
/// @brief Provide functions to emulate GLSL swizzle operator fonctionalities.
///
/// <glm/gtc/swizzle.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_swizzle
@@ -42,6 +49,9 @@
namespace glm{
namespace gtc
{
/// @addtogroup gtc_half_float
/// @{
template <typename T, template <typename> class vecType>
T const & swizzle(
vecType<T> const & v,
@@ -358,6 +368,7 @@ namespace gtc
static_swizzle4_ref(glm::u32, 4)
static_swizzle4_ref(glm::u64, 4)
/// @}
}//namespace gtc
}//namespace glm

View File

@@ -28,6 +28,16 @@
/// @see core (dependence)
/// @see gtc_half_float (dependence)
/// @see gtc_quaternion (dependence)
///
/// @defgroup gtc_type_precision GLM_GTC_type_precision: Vector and matrix types with defined precisions
/// @ingroup gtc
///
/// @brief Defines specific C++-based precision types.
///
/// @ref core_precision defines types based on GLSL's precision qualifiers. This
/// extension defines types based on explicitly-sized C++ data types.
///
/// <glm/gtc/type_precision.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_type_precision

View File

@@ -28,6 +28,32 @@
/// @see core (dependence)
/// @see gtc_half_float (dependence)
/// @see gtc_quaternion (dependence)
///
/// @defgroup gtc_type_ptr GLM_GTC_type_ptr: Memory layout access
/// @ingroup gtc
///
/// @brief Used to get a pointer to the memory layout of a basic type.
///
/// This extension defines an overloaded function, glm::value_ptr, which
/// takes any of the \ref core_template "core template types". It returns
/// a pointer to the memory layout of the object. Matrix types store their values
/// in column-major order.
///
/// This is useful for uploading data to matrices or copying data to buffer objects.
///
/// Example:
/// @code
/// #include <glm/glm.hpp>
/// #include <glm/gtc/type_ptr.hpp>
///
/// glm::vec3 aVector(3);
/// glm::mat4 someMatrix(1.0);
///
/// glUniform3fv(uniformLoc, 1, glm::value_ptr(aVector));
/// glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix));
/// @endcode
///
/// <glm/gtc/type_ptr.hpp> need to be included to use these functionalities.
///////////////////////////////////////////////////////////////////////////////////
#ifndef glm_gtc_type_ptr
@@ -44,7 +70,8 @@
#endif
namespace glm{
namespace gtc{
namespace gtc
{
/// @addtogroup gtc_type_ptr
/// @{