From 52534b80f8e16c6ff674b1ac4977bd47ef305839 Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Wed, 13 Apr 2011 07:46:04 +0100 Subject: [PATCH] Added GLSL man page links for trigonometric functions --- glm/core/func_trigonometric.hpp | 60 ++++++++++++++++++++++++--------- 1 file changed, 45 insertions(+), 15 deletions(-) diff --git a/glm/core/func_trigonometric.hpp b/glm/core/func_trigonometric.hpp index 4d147bfb..34e62579 100644 --- a/glm/core/func_trigonometric.hpp +++ b/glm/core/func_trigonometric.hpp @@ -27,43 +27,57 @@ namespace glm ///@{ //! Converts degrees to radians and returns the result. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL radians man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType radians(genType const & degrees); //! Converts radians to degrees and returns the result. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL degrees man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType degrees(genType const & radians); //! The standard trigonometric sine function. //! The values returned by this function will range from [-1, 1]. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL sin man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType sin(genType const & angle); //! The standard trigonometric cosine function. //! The values returned by this function will range from [-1, 1]. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL cos man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType cos(genType const & angle); //! The standard trigonometric tangent function. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL tan man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType tan(genType const & angle); //! Arc sine. Returns an angle whose sine is x. //! The range of values returned by this function is [-PI/2, PI/2]. //! Results are undefined if |x| > 1. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL asin man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType asin(genType const & x); //! Arc cosine. Returns an angle whose sine is x. //! The range of values returned by this function is [0, PI]. //! Results are undefined if |x| > 1. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL acos man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType acos(genType const & x); @@ -72,45 +86,61 @@ namespace glm //! quadrant the angle is in. The range of values returned //! by this function is [-PI, PI]. Results are undefined //! if x and y are both 0. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL atan man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType atan(genType const & y, genType const & x); //! Arc tangent. Returns an angle whose tangent is y_over_x. //! The range of values returned by this function is [-PI/2, PI/2]. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL atan man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType atan(genType const & y_over_x); //! Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2 - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL sinh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType sinh(genType const & angle); //! Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2 - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL cosh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType cosh(genType const & angle); //! Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL tanh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType tanh(genType const & angle); //! Arc hyperbolic sine; returns the inverse of sinh. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL asinh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType asinh(genType const & x); //! Arc hyperbolic cosine; returns the non-negative inverse //! of cosh. Results are undefined if x < 1. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL acosh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType acosh(genType const & x); //! Arc hyperbolic tangent; returns the inverse of tanh. //! Results are undefined if abs(x) >= 1. - //! (From GLSL 1.30.08 specification, section 8.1) + //! + //! \li GLSL atanh man page + //! \li GLSL 1.30.08 specification, section 8.1 template genType atanh(genType const & x);