Document the undefined behaviour of CLAMP() if low > high. (#448260)

2007-06-16  Emmanuele Bassi  <ebassi@gnome.org>

        * glib/tmpl/macros.sgml: Document the undefined behaviour of
        CLAMP() if low > high. (#448260)

svn path=/trunk/; revision=5571

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 41f09a9..fc77b44 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2007-06-16  Emmanuele Bassi  <ebassi@gnome.org>
+
+       * glib/tmpl/macros.sgml: Document the undefined behaviour of
+       CLAMP() if low > high. (#448260)
+
 2007-06-13  Sven Neumann  <sven@gimp.org>
 
        * glib/glib-sections.txt

diff --git a/docs/reference/glib/tmpl/macros.sgml b/docs/reference/glib/tmpl/macros.sgml
index e453ed2..efa2779 100644 (file)
--- a/docs/reference/glib/tmpl/macros.sgml
+++ b/docs/reference/glib/tmpl/macros.sgml
@@ -148,7 +148,8 @@ ABS(10) is also 10.
 
 <!-- ##### MACRO CLAMP ##### -->
 <para>
-Ensures that @x is between the limits set by @low and @high.
+Ensures that @x is between the limits set by @low and @high. If @low is
+greater than @high the result is undefined.
 </para>
 <para>
 For example,