docs: Fix return value for g_datetime_compare()
authorBenjamin Otte <otte@redhat.com>
Sat, 12 Feb 2011 16:56:34 +0000 (17:56 +0100)
committerBenjamin Otte <otte@redhat.com>
Sat, 12 Feb 2011 16:56:34 +0000 (17:56 +0100)
Previous code confused dt1 and dt2. The new formulation is stolen from
man strcmp() and g_strcmp0().

glib/gdatetime.c

index 0c47006..2957817 100644 (file)
@@ -1319,8 +1319,8 @@ g_date_time_add_full (GDateTime *datetime,
  * #GCompareFunc-compatible comparison for #GDateTime<!-- -->'s. Both
  * #GDateTime<-- -->'s must be non-%NULL.
  *
- * Return value: 0 for equal, less than zero if dt1 is less than dt2, greater
- *   than zero if dt2 is greator than dt1.
+ * Returnsvalue: -1, 0 or 1 if @dt1 is less than, equal to or greater
+ *   than @dt2.
  *
  * Since: 2.26
  */