doc: improve briefs

recp · Aug 27, 2024 · ad009d4 · ad009d4
1 parent 2f619cd
commit ad009d4
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/include/cglm/struct/vec2-ext.h b/include/cglm/struct/vec2-ext.h
@@ -133,7 +133,7 @@ glms_vec2_min(vec2s v) {
 }
 
 /*!
- * @brief check if all items are NaN (not a number)
+ * @brief check if one of items is NaN (not a number)
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector
@@ -145,7 +145,7 @@ glms_vec2_(isnan)(vec2s v) {
 }
 
 /*!
- * @brief check if all items are INFINITY
+ * @brief check if one of items is INFINITY
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector

diff --git a/include/cglm/struct/vec3-ext.h b/include/cglm/struct/vec3-ext.h
@@ -151,7 +151,7 @@ glms_vec3_(min)(vec3s v) {
 }
 
 /*!
- * @brief check if all items are NaN (not a number)
+ * @brief check if one of items is NaN (not a number)
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector
@@ -163,7 +163,7 @@ glms_vec3_(isnan)(vec3s v) {
 }
 
 /*!
- * @brief check if all items are INFINITY
+ * @brief check if one of items is INFINITY
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector

diff --git a/include/cglm/vec2-ext.h b/include/cglm/vec2-ext.h
@@ -128,7 +128,7 @@ glm_vec2_min(vec2 v) {
 }
 
 /*!
- * @brief check if all items are NaN (not a number)
+ * @brief check if one of items is NaN (not a number)
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector
@@ -140,7 +140,7 @@ glm_vec2_isnan(vec2 v) {
 }
 
 /*!
- * @brief check if all items are INFINITY
+ * @brief check if one of items is INFINITY
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector

diff --git a/include/cglm/vec3-ext.h b/include/cglm/vec3-ext.h
@@ -164,7 +164,7 @@ glm_vec3_min(vec3 v) {
 }
 
 /*!
- * @brief check if all items are NaN (not a number)
+ * @brief check if one of items is NaN (not a number)
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector
@@ -176,7 +176,7 @@ glm_vec3_isnan(vec3 v) {
 }
 
 /*!
- * @brief check if all items are INFINITY
+ * @brief check if one of items is INFINITY
  *        you should only use this in DEBUG mode or very critical asserts
  *
  * @param[in] v vector