changeset 632:3d238b43a9aa

core: document clampi/clampu
author David Demelier <markand@malikania.fr>
date Sun, 27 Aug 2023 13:22:51 +0200
parents bb67f935a93f
children 6271599928d4
files libmlk-core/mlk/core/util.c libmlk-core/mlk/core/util.h
diffstat 2 files changed, 10 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libmlk-core/mlk/core/util.c	Sun Aug 27 11:28:35 2023 +0200
+++ b/libmlk-core/mlk/core/util.c	Sun Aug 27 13:22:51 2023 +0200
@@ -57,7 +57,6 @@
 mlk_clampi(intmax_t v, intmax_t min, intmax_t max)
 {
 	return v < min ? min : v > max ? max : v;
-	
 }
 
 uintmax_t
--- a/libmlk-core/mlk/core/util.h	Sun Aug 27 11:28:35 2023 +0200
+++ b/libmlk-core/mlk/core/util.h	Sun Aug 27 13:22:51 2023 +0200
@@ -75,9 +75,19 @@
 unsigned int
 mlk_util_nrand(unsigned int min, unsigned int max);
 
+/**
+ * Clamp a value between limits.
+ *
+ * \return v clamped to min or max depending on the current v value
+ */
 intmax_t
 mlk_clampi(intmax_t v, intmax_t min, intmax_t max);
 
+/**
+ * Clamp a value between limits.
+ *
+ * \return v clamped to min or max depending on the current v value
+ */
 uintmax_t
 mlk_clampu(uintmax_t v, uintmax_t min, uintmax_t max);