瀏覽代碼

More consistent coding style

Christophe Riccio 8 年之前
父節點
當前提交
d1afe662be

+ 11 - 11
glm/detail/qualifier.hpp

@@ -10,21 +10,21 @@ namespace glm
 	/// Qualify GLM types in term of alignment (packed, aligned) and precision in term of ULPs (lowp, mediump, highp)
 	/// Qualify GLM types in term of alignment (packed, aligned) and precision in term of ULPs (lowp, mediump, highp)
 	enum qualifier
 	enum qualifier
 	{
 	{
-		packed_highp,
-		packed_mediump,
-		packed_lowp,
+		packed_highp, ///< Typed data is tightly packed in memory and operations are executed with high precision in term of ULPs
+		packed_mediump, ///< Typed data is tightly packed in memory  and operations are executed with medium precision in term of ULPs for higher performance
+		packed_lowp, ///< Typed data is tightly packed in memory  and operations are executed with low precision in term of ULPs to maximize performance
 
 
 #		if GLM_HAS_ALIGNED_TYPE
 #		if GLM_HAS_ALIGNED_TYPE
-			aligned_highp,
-			aligned_mediump,
-			aligned_lowp,
-			aligned = aligned_highp,
+			aligned_highp, ///< Typed data is aligned in memory allowing SIMD optimizations and operations are executed with high precision in term of ULPs
+			aligned_mediump, ///< Typed data is aligned in memory allowing SIMD optimizations and operations are executed with high precision in term of ULPs for higher performance
+			aligned_lowp, // ///< Typed data is aligned in memory allowing SIMD optimizations and operations are executed with high precision in term of ULPs to maximize performance
+			aligned = aligned_highp, ///< By default aligned qualifier is also high precision
 #		endif
 #		endif
 
 
-		highp = packed_highp,
-		mediump = packed_mediump,
-		lowp = packed_lowp,
-		packed = packed_highp,
+		highp = packed_highp, ///< By default highp qualifier is also packed
+		mediump = packed_mediump, ///< By default mediump qualifier is also packed
+		lowp = packed_lowp, ///< By default lowp qualifier is also packed
+		packed = packed_highp, ///< By default packed qualifier is also high precision
 
 
 #		if GLM_HAS_ALIGNED_TYPE && defined(GLM_FORCE_ALIGNED)
 #		if GLM_HAS_ALIGNED_TYPE && defined(GLM_FORCE_ALIGNED)
 			defaultp = aligned_highp
 			defaultp = aligned_highp

+ 1 - 1
glm/gtx/extended_min_max.hpp

@@ -25,7 +25,7 @@
 
 
 namespace glm
 namespace glm
 {
 {
-	/// @addtogroup gtx_extented_min_max
+	/// @addtogroup gtx_extended_min_max
 	/// @{
 	/// @{
 
 
 	/// Return the minimum component-wise values of 3 inputs 
 	/// Return the minimum component-wise values of 3 inputs 

+ 4 - 6
glm/gtx/normal.hpp

@@ -29,13 +29,11 @@ namespace glm
 	/// @addtogroup gtx_normal
 	/// @addtogroup gtx_normal
 	/// @{
 	/// @{
 
 
-	//! Computes triangle normal from triangle points. 
-	//! From GLM_GTX_normal extension.
+	/// Computes triangle normal from triangle points. 
+	///
+	/// @see gtx_normal
 	template<typename T, qualifier P> 
 	template<typename T, qualifier P> 
-	GLM_FUNC_DECL vec<3, T, P> triangleNormal(
-		vec<3, T, P> const & p1, 
-		vec<3, T, P> const & p2, 
-		vec<3, T, P> const & p3);
+	GLM_FUNC_DECL vec<3, T, P> triangleNormal(vec<3, T, P> const & p1, vec<3, T, P> const & p2, vec<3, T, P> const & p3);
 
 
 	/// @}
 	/// @}
 }//namespace glm
 }//namespace glm

+ 1 - 1
test/core/core_type_mat3x3.cpp

@@ -13,7 +13,7 @@
 #include <cstdio>
 #include <cstdio>
 #include <vector>
 #include <vector>
 
 
-void print(glm::dmat3 const & Mat0)
+void print(glm::dmat3 const& Mat0)
 {
 {
 	printf("mat3(\n");
 	printf("mat3(\n");
 	printf("\tvec3(%2.3f, %2.3f, %2.3f)\n", Mat0[0][0], Mat0[0][1], Mat0[0][2]);
 	printf("\tvec3(%2.3f, %2.3f, %2.3f)\n", Mat0[0][0], Mat0[0][1], Mat0[0][2]);

+ 1 - 1
test/core/core_type_mat4x4.cpp

@@ -14,7 +14,7 @@
 
 
 
 
 template<typename genType>
 template<typename genType>
-void print(genType const & Mat0)
+void print(genType const& Mat0)
 {
 {
 	printf("mat4(\n");
 	printf("mat4(\n");
 	printf("\tvec4(%2.9f, %2.9f, %2.9f, %2.9f)\n", static_cast<double>(Mat0[0][0]), static_cast<double>(Mat0[0][1]), static_cast<double>(Mat0[0][2]), static_cast<double>(Mat0[0][3]));
 	printf("\tvec4(%2.9f, %2.9f, %2.9f, %2.9f)\n", static_cast<double>(Mat0[0][0]), static_cast<double>(Mat0[0][1]), static_cast<double>(Mat0[0][2]), static_cast<double>(Mat0[0][3]));

+ 1 - 1
test/gtx/gtx_type_aligned.cpp

@@ -80,7 +80,7 @@ int test_decl()
 }
 }
 
 
 template<typename genType>
 template<typename genType>
-void print(genType const & Mat0)
+void print(genType const& Mat0)
 {
 {
 	printf("mat4(\n");
 	printf("mat4(\n");
 	printf("\tvec4(%2.9f, %2.9f, %2.9f, %2.9f)\n", static_cast<double>(Mat0[0][0]), static_cast<double>(Mat0[0][1]), static_cast<double>(Mat0[0][2]), static_cast<double>(Mat0[0][3]));
 	printf("\tvec4(%2.9f, %2.9f, %2.9f, %2.9f)\n", static_cast<double>(Mat0[0][0]), static_cast<double>(Mat0[0][1]), static_cast<double>(Mat0[0][2]), static_cast<double>(Mat0[0][3]));