ソースを参照

Improved GTC_reciprocal documentation

Christophe Riccio 10 年 前
コミット
045e5bee1a
2 ファイル変更44 行追加13 行削除
  1. 42 12
      glm/gtc/reciprocal.hpp
  2. 2 1
      readme.md

+ 42 - 12
glm/gtc/reciprocal.hpp

@@ -56,77 +56,107 @@ namespace glm
 	/// Secant function. 
 	/// Secant function. 
 	/// hypotenuse / adjacent or 1 / cos(x)
 	/// hypotenuse / adjacent or 1 / cos(x)
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType sec(genType const & angle);
+	GLM_FUNC_DECL genType sec(genType angle);
 
 
 	/// Cosecant function. 
 	/// Cosecant function. 
 	/// hypotenuse / opposite or 1 / sin(x)
 	/// hypotenuse / opposite or 1 / sin(x)
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType csc(genType const & angle);
+	GLM_FUNC_DECL genType csc(genType angle);
 		
 		
 	/// Cotangent function. 
 	/// Cotangent function. 
 	/// adjacent / opposite or 1 / tan(x)
 	/// adjacent / opposite or 1 / tan(x)
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType cot(genType const & angle);
+	GLM_FUNC_DECL genType cot(genType angle);
 
 
 	/// Inverse secant function. 
 	/// Inverse secant function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType asec(genType const & x);
+	GLM_FUNC_DECL genType asec(genType x);
 
 
 	/// Inverse cosecant function. 
 	/// Inverse cosecant function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType acsc(genType const & x);
+	GLM_FUNC_DECL genType acsc(genType x);
 		
 		
 	/// Inverse cotangent function. 
 	/// Inverse cotangent function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType acot(genType const & x);
+	GLM_FUNC_DECL genType acot(genType x);
 
 
 	/// Secant hyperbolic function. 
 	/// Secant hyperbolic function. 
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType sech(genType const & angle);
+	GLM_FUNC_DECL genType sech(genType angle);
 
 
 	/// Cosecant hyperbolic function. 
 	/// Cosecant hyperbolic function. 
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType csch(genType const & angle);
+	GLM_FUNC_DECL genType csch(genType angle);
 		
 		
 	/// Cotangent hyperbolic function. 
 	/// Cotangent hyperbolic function. 
 	/// 
 	/// 
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType coth(genType const & angle);
+	GLM_FUNC_DECL genType coth(genType angle);
 
 
 	/// Inverse secant hyperbolic function. 
 	/// Inverse secant hyperbolic function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType asech(genType const & x);
+	GLM_FUNC_DECL genType asech(genType x);
 
 
 	/// Inverse cosecant hyperbolic function. 
 	/// Inverse cosecant hyperbolic function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType acsch(genType const & x);
+	GLM_FUNC_DECL genType acsch(genType x);
 		
 		
 	/// Inverse cotangent hyperbolic function. 
 	/// Inverse cotangent hyperbolic function. 
 	/// 
 	/// 
+	/// @return Return an angle expressed in radians.
+	/// @tparam genType Floating-point scalar or vector types.
+	/// 
 	/// @see gtc_reciprocal
 	/// @see gtc_reciprocal
 	template <typename genType> 
 	template <typename genType> 
-	GLM_FUNC_DECL genType acoth(genType const & x);
+	GLM_FUNC_DECL genType acoth(genType x);
 
 
 	/// @}
 	/// @}
 }//namespace glm
 }//namespace glm

+ 2 - 1
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
 - Added packF3x9_E1x5 and unpackF3x9_E1x5 to GTC_packing for RGB9E5 #416
 
 
 ##### Improvements:
 ##### 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
 #### [GLM 0.9.7.2](https://github.com/g-truc/glm/tree/0.9.7) - 2015-XX-XX
 ##### Fixes:
 ##### Fixes: