diff --git a/doc/pages.doxy b/doc/pages.doxy index d30242e2..1939d569 100644 --- a/doc/pages.doxy +++ b/doc/pages.doxy @@ -26,14 +26,7 @@ Thanks for contributing to the project by submitting tickets for bug reports and feature requests. (SF.net account required). Any feedback is welcome at glm@g-truc.net. - \li \subpage pg_started - \li \subpage pg_advanced - \li \subpage pg_differences - \li \subpage pg_deprecated - \li \subpage pg_issues - \li \subpage pg_faq - \li \subpage pg_samples - \li \subpage pg_reference + These pages are the API reference only. For more information about how to use GLM, please have a look at the manual. **/ /*! diff --git a/glm/core/func_vector_relational.hpp b/glm/core/func_vector_relational.hpp index 1da814b8..9df6e7ad 100644 --- a/glm/core/func_vector_relational.hpp +++ b/glm/core/func_vector_relational.hpp @@ -55,7 +55,7 @@ namespace glm /// @see - GLSL lessThan man page /// @see - GLSL 4.20.8 specification, section 8.7 template - GLM_FUNC_QUALIFIER typename vecType::bool_type lessThan(vecType const & x, vecType const & y); + typename vecType::bool_type lessThan(vecType const & x, vecType const & y); /// Returns the component-wise comparison of result x <= y. /// @@ -63,8 +63,8 @@ namespace glm /// /// @see - GLSL lessThanEqual man page /// @see - GLSL 4.20.8 specification, section 8.7 - template class vecType> - GLM_FUNC_QUALIFIER typename vecType::bool_type lessThanEqual(vecType const & x, vecType const & y); + template + typename vecType::bool_type lessThanEqual(vecType const & x, vecType const & y); /// Returns the component-wise comparison of result x > y. /// @@ -72,8 +72,8 @@ namespace glm /// /// @see - GLSL greaterThan man page /// @see - GLSL 4.20.8 specification, section 8.7 - template class vecType> - GLM_FUNC_QUALIFIER typename vecType::bool_type greaterThan(vecType const & x, vecType const & y); + template + typename vecType::bool_type greaterThan(vecType const & x, vecType const & y); /// Returns the component-wise comparison of result x >= y. /// @@ -81,8 +81,8 @@ namespace glm /// /// @see - GLSL greaterThanEqual man page /// @see - GLSL 4.20.8 specification, section 8.7 - template class vecType> - typename vecType::bool_type greaterThanEqual(vecType const & x, vecType const & y); + template + typename vecType::bool_type greaterThanEqual(vecType const & x, vecType const & y); /// Returns the component-wise comparison of result x == y. /// @@ -90,8 +90,8 @@ namespace glm /// /// @see - GLSL equal man page /// @see - GLSL 4.20.8 specification, section 8.7 - template class vecType> - GLM_FUNC_QUALIFIER typename vecType::bool_type equal(vecType const & x, vecType const & y); + template + typename vecType::bool_type equal(vecType const & x, vecType const & y); /// Returns the component-wise comparison of result x != y. /// @@ -99,8 +99,8 @@ namespace glm /// /// @see - GLSL notEqual man page /// @see - GLSL 4.20.8 specification, section 8.7 - template class vecType> - typename vecType::bool_type notEqual(vecType const & x, vecType const & y); + template + typename vecType::bool_type notEqual(vecType const & x, vecType const & y); /// Returns true if any component of x is true. /// diff --git a/glm/gtc/noise.hpp b/glm/gtc/noise.hpp index 29a7c121..71edfef7 100644 --- a/glm/gtc/noise.hpp +++ b/glm/gtc/noise.hpp @@ -27,16 +27,15 @@ /// /// @see core (dependence) /// -/// @defgroup gtx_noise GLM_GTX_noise: Procedural noise functions -/// @ingroup gtx +/// @defgroup gtc_noise GLM_GTC_noise: Procedural noise functions +/// @ingroup gtc /// /// Defines 2D, 3D and 4D procedural noise functions /// Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": /// https://github.com/ashima/webgl-noise /// Following Stefan Gustavson's paper "Simplex noise demystified": /// http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf -/// Defines the half-precision floating-point type, along with various typedefs for vectors and matrices. -/// need to be included to use these functionalities. +/// need to be included to use these functionalities. /////////////////////////////////////////////////////////////////////////////////// #ifndef GLM_GTC_noise @@ -51,7 +50,7 @@ namespace glm { - /// @addtogroup gtx_noise + /// @addtogroup gtc_noise /// @{ /// Classic perlin noise. diff --git a/glm/gtc/quaternion.hpp b/glm/gtc/quaternion.hpp index b6e750e2..9ed8b7fe 100644 --- a/glm/gtc/quaternion.hpp +++ b/glm/gtc/quaternion.hpp @@ -150,21 +150,21 @@ namespace detail /// @addtogroup gtc_quaternion /// @{ - //! Returns the length of the quaternion. + /// Returns the length of the quaternion. /// /// @see - gtc_quaternion template T length( detail::tquat const & q); - //! Returns the normalized quaternion. + /// Returns the normalized quaternion. /// /// @see - gtc_quaternion template detail::tquat normalize( detail::tquat const & q); - //! Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... + /// Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... /// /// @see - gtc_quaternion template @@ -172,7 +172,7 @@ namespace detail detail::tquat const & q1, detail::tquat const & q2); - //! Returns a SLERP interpolated quaternion of x and y according a. + /// Returns a SLERP interpolated quaternion of x and y according a. /// /// @see - gtc_quaternion template @@ -181,21 +181,21 @@ namespace detail detail::tquat const & y, T const & a); - //! Returns the q conjugate. + /// Returns the q conjugate. /// /// @see - gtc_quaternion template detail::tquat conjugate( detail::tquat const & q); - //! Returns the q inverse. + /// Returns the q inverse. /// /// @see - gtc_quaternion template detail::tquat inverse( detail::tquat const & q); - //! Rotates a quaternion from an vector of 3 components axis and an angle expressed in degrees. + /// Rotates a quaternion from an vector of 3 components axis and an angle expressed in degrees. /// /// @see - gtc_quaternion template @@ -204,65 +204,65 @@ namespace detail typename detail::tquat::value_type const & angle, detail::tvec3 const & v); - //! Converts a quaternion to a 3 * 3 matrix. + /// Converts a quaternion to a 3 * 3 matrix. /// /// @see - gtc_quaternion template detail::tmat3x3 mat3_cast( detail::tquat const & x); - //! Converts a quaternion to a 4 * 4 matrix. + /// Converts a quaternion to a 4 * 4 matrix. /// /// @see - gtc_quaternion template detail::tmat4x4 mat4_cast( detail::tquat const & x); - //! Converts a 3 * 3 matrix to a quaternion. + /// Converts a 3 * 3 matrix to a quaternion. /// /// @see - gtc_quaternion template detail::tquat quat_cast( detail::tmat3x3 const & x); - //! Converts a 4 * 4 matrix to a quaternion. + /// Converts a 4 * 4 matrix to a quaternion. /// /// @see - gtc_quaternion template detail::tquat quat_cast( detail::tmat4x4 const & x); - //! Quaternion of floating-point numbers. + /// Quaternion of floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat quat; - //! Quaternion of half-precision floating-point numbers. + /// Quaternion of half-precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat hquat; - //! Quaternion of single-precision floating-point numbers. + /// Quaternion of single-precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat fquat; - //! Quaternion of double-precision floating-point numbers. + /// Quaternion of double-precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat dquat; - //! Quaternion of low precision floating-point numbers. + /// Quaternion of low precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat lowp_quat; - //! Quaternion of medium precision floating-point numbers. + /// Quaternion of medium precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat mediump_quat; - //! Quaternion of high precision floating-point numbers. + /// Quaternion of high precision floating-point numbers. /// /// @see - gtc_quaternion typedef detail::tquat highp_quat; diff --git a/glm/gtc/random.hpp b/glm/gtc/random.hpp index 5d5ceeec..688426ab 100644 --- a/glm/gtc/random.hpp +++ b/glm/gtc/random.hpp @@ -32,7 +32,7 @@ /// @defgroup gtc_random GLM_GTC_random: Random number generation /// @ingroup gtc /// -/// @brief Generate random number from various distribution methods +/// @brief Generate random number from various distribution methods. /// /// need to be included to use these functionalities. /////////////////////////////////////////////////////////////////////////////////// diff --git a/glm/gtc/type_ptr.hpp b/glm/gtc/type_ptr.hpp index d95771d9..7684630f 100644 --- a/glm/gtc/type_ptr.hpp +++ b/glm/gtc/type_ptr.hpp @@ -32,7 +32,7 @@ /// @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. +/// @brief Handles the interaction between pointers and vector, matrix types. /// /// This extension defines an overloaded function, glm::value_ptr, which /// takes any of the \ref core_template "core template types". It returns