gst/gstvalue.c: Improve documentation for gst_value_union().

Original commit message from CVS:
* gst/gstvalue.c:
Improve documentation for gst_value_union().
* gst/gstvalue.h:
Change return value for union, intersect and subtract functions
from gint to gboolean.

diff --git a/ChangeLog b/ChangeLog
index 9a32b54..e4cc4d2 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2005-11-27  Tim-Philipp Müller  <tim at centricular dot net>
 
+       * gst/gstvalue.c:
+         Improve documentation for gst_value_union().
+
+       * gst/gstvalue.h:
+         Change return value for union, intersect and subtract functions
+         from gint to gboolean.
+
+2005-11-27  Tim-Philipp Müller  <tim at centricular dot net>
+
        * gst/gstvalue.c: (gst_value_serialize_any_list),
        (gst_value_transform_any_list_string),
        (gst_value_deserialize_list), (gst_value_deserialize_array),

diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index 4ba2ddb..60d040e 100644 (file)
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -2675,7 +2675,7 @@ gst_value_can_union (const GValue * value1, const GValue * value2)
  *
  * Creates a GValue cooresponding to the union of @value1 and @value2.
  *
- * Returns: %TRUE if a union was successful
+ * Returns: always returns %TRUE
  */
 /* FIXME: change return type to 'void'? */
 gboolean

diff --git a/gst/gstvalue.h b/gst/gstvalue.h
index 9e33bc6..4a19f0d 100644 (file)
--- a/gst/gstvalue.h
+++ b/gst/gstvalue.h
@@ -317,8 +317,7 @@ typedef gboolean (* GstValueDeserializeFunc) (GValue       *dest,
  *
  * Returns: %TRUE if a union was successful
  */
-/* FIXME: shouldn't the return value be gboolean ? */
-typedef gint     (* GstValueUnionFunc)       (GValue       *dest,
+typedef gboolean (* GstValueUnionFunc)       (GValue       *dest,
                                              const GValue *value1,
                                              const GValue *value2);
 
@@ -336,8 +335,7 @@ typedef gint     (* GstValueUnionFunc)       (GValue       *dest,
  *
  * Returns: %TRUE if the values can intersect
  */
-/* FIXME: shouldn't the return value be gboolean ? */
-typedef gint     (* GstValueIntersectFunc)   (GValue       *dest,
+typedef gboolean (* GstValueIntersectFunc)   (GValue       *dest,
                                              const GValue *value1,
                                              const GValue *value2);
 
@@ -352,8 +350,7 @@ typedef gint     (* GstValueIntersectFunc)   (GValue       *dest,
  *
  * Returns: %TRUE if the subtraction is not empty
  */
-/* FIXME: shouldn't the return value be gboolean ? */
-typedef gint     (* GstValueSubtractFunc)    (GValue       *dest,
+typedef gboolean (* GstValueSubtractFunc)    (GValue       *dest,
                                              const GValue *minuend,
                                              const GValue *subtrahend);