From 64a2515f8234e79c36eeeec915471e89fdf85676 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Sat, 16 Jul 2016 14:35:59 +0200
Subject: doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Mattias Andrée <maandree@kth.se>
---
src/libclut.h | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
(limited to 'src')
diff --git a/src/libclut.h b/src/libclut.h
index 76f4840..60ef414 100644
--- a/src/libclut.h
+++ b/src/libclut.h
@@ -23,7 +23,9 @@
-/* This is to avoid warnings about comparing double, which is safe in our case. { */
+/* This is to avoid warnings about comparing double, These are only
+ * used when it is safe, for example to test whether optimisations
+ * are possible. { */
#if defined(__GNUC__) || defined(__clang__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wfloat-equal"
@@ -358,6 +360,11 @@ static inline int libclut_0__(double x) { return libclut_eq__(x, 0); }
* only way to adjust the blackpoint on many LCD
* monitors.
*
+ * Warning. Stops that is too close 0 when using
+ * floating-point values, get generate overly
+ * large results. Values too close to `max` when
+ * using floating-point values, get generate `nan`.
+ *
* None of the parameter may have side-effects.
*
* Requires linking with '-lm'.
--
cgit v1.2.3-70-g09d2