From 045e5bee1a1e81e9b963706110a83b0a3aa346f2 Mon Sep 17 00:00:00 2001 From: Christophe Riccio Date: Wed, 7 Oct 2015 21:41:05 +0200 Subject: [PATCH] Improved GTC_reciprocal documentation --- glm/gtc/reciprocal.hpp | 62 +++++++++++++++++++++++++++++++----------- readme.md | 3 +- 2 files changed, 48 insertions(+), 17 deletions(-) diff --git a/glm/gtc/reciprocal.hpp b/glm/gtc/reciprocal.hpp index 72480788..916dfb40 100644 --- a/glm/gtc/reciprocal.hpp +++ b/glm/gtc/reciprocal.hpp @@ -56,77 +56,107 @@ namespace glm /// Secant function. /// hypotenuse / adjacent or 1 / cos(x) /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType sec(genType const & angle); + GLM_FUNC_DECL genType sec(genType angle); /// Cosecant function. /// hypotenuse / opposite or 1 / sin(x) /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType csc(genType const & angle); + GLM_FUNC_DECL genType csc(genType angle); /// Cotangent function. /// adjacent / opposite or 1 / tan(x) /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType cot(genType const & angle); + GLM_FUNC_DECL genType cot(genType angle); /// Inverse secant function. /// + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType asec(genType const & x); + GLM_FUNC_DECL genType asec(genType x); /// Inverse cosecant function. /// + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType acsc(genType const & x); + GLM_FUNC_DECL genType acsc(genType x); /// Inverse cotangent function. /// + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType acot(genType const & x); + GLM_FUNC_DECL genType acot(genType x); /// Secant hyperbolic function. /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType sech(genType const & angle); + GLM_FUNC_DECL genType sech(genType angle); /// Cosecant hyperbolic function. /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType csch(genType const & angle); + GLM_FUNC_DECL genType csch(genType angle); /// Cotangent hyperbolic function. /// + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType coth(genType const & angle); + GLM_FUNC_DECL genType coth(genType angle); /// Inverse secant hyperbolic function. /// + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. + /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType asech(genType const & x); + GLM_FUNC_DECL genType asech(genType x); /// Inverse cosecant hyperbolic function. /// - /// @see gtc_reciprocal - template - GLM_FUNC_DECL genType acsch(genType const & x); - - /// Inverse cotangent hyperbolic function. + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. /// /// @see gtc_reciprocal template - GLM_FUNC_DECL genType acoth(genType const & x); + GLM_FUNC_DECL genType acsch(genType x); + + /// Inverse cotangent hyperbolic function. + /// + /// @return Return an angle expressed in radians. + /// @tparam genType Floating-point scalar or vector types. + /// + /// @see gtc_reciprocal + template + GLM_FUNC_DECL genType acoth(genType x); /// @} }//namespace glm diff --git a/readme.md b/readme.md index 0744eefd..d392483d 100644 --- a/readme.md +++ b/readme.md @@ -57,7 +57,8 @@ glm::mat4 camera(float Translate, glm::vec2 const & Rotate) - Added packF3x9_E1x5 and unpackF3x9_E1x5 to GTC_packing for RGB9E5 #416 ##### Improvements: -- Improved GTC_random linearRand documentations +- Improved GTC_random linearRand documentation +- Improved GTC_reciprocal documentation #### [GLM 0.9.7.2](https://github.com/g-truc/glm/tree/0.9.7) - 2015-XX-XX ##### Fixes: