From 09155986fe8caf1aba1bf7d691feb7f3ad99d148 Mon Sep 17 00:00:00 2001
From: Christopher Lang <christopher.lang.256@gmail.com>
Date: Fri, 20 May 2022 16:49:23 +0100
Subject: [PATCH] Update ivec[2|3|4]_distance2 doc comments

---
 include/cglm/ivec2.h | 2 +-
 include/cglm/ivec3.h | 2 +-
 include/cglm/ivec4.h | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/cglm/ivec2.h b/include/cglm/ivec2.h
index 3831a32..f4b2bdb 100644
--- a/include/cglm/ivec2.h
+++ b/include/cglm/ivec2.h
@@ -166,7 +166,7 @@ glm_ivec2_scale(ivec2 v, int s, ivec2 dest) {
  *
  * @param[in] a first vector
  * @param[in] b second vector
- * @return returns squared distance
+ * @return returns squared distance (distance * distance)
  */
 CGLM_INLINE
 int
diff --git a/include/cglm/ivec3.h b/include/cglm/ivec3.h
index 00edf84..621434d 100644
--- a/include/cglm/ivec3.h
+++ b/include/cglm/ivec3.h
@@ -174,7 +174,7 @@ glm_ivec3_scale(ivec3 v, int s, ivec3 dest) {
  *
  * @param[in] a first vector
  * @param[in] b second vector
- * @return returns squared distance
+ * @return returns squared distance (distance * distance)
  */
 CGLM_INLINE
 int
diff --git a/include/cglm/ivec4.h b/include/cglm/ivec4.h
index 0a837bb..8724e3c 100644
--- a/include/cglm/ivec4.h
+++ b/include/cglm/ivec4.h
@@ -183,7 +183,7 @@ glm_ivec4_scale(ivec4 v, int s, ivec4 dest) {
  *
  * @param[in] a first vector
  * @param[in] b second vector
- * @return returns squared distance
+ * @return returns squared distance (distance * distance)
  */
 CGLM_INLINE
 int