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.
This commit is contained in:
Tim-Philipp Müller 2005-11-27 19:52:49 +00:00
parent abaf6b22f1
commit 676421cf07
3 changed files with 13 additions and 7 deletions

View file

@ -1,3 +1,12 @@
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> 2005-11-27 Tim-Philipp Müller <tim at centricular dot net>
* gst/gstvalue.c: (gst_value_serialize_any_list), * gst/gstvalue.c: (gst_value_serialize_any_list),

View file

@ -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. * 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'? */ /* FIXME: change return type to 'void'? */
gboolean gboolean

View file

@ -317,8 +317,7 @@ typedef gboolean (* GstValueDeserializeFunc) (GValue *dest,
* *
* Returns: %TRUE if a union was successful * Returns: %TRUE if a union was successful
*/ */
/* FIXME: shouldn't the return value be gboolean ? */ typedef gboolean (* GstValueUnionFunc) (GValue *dest,
typedef gint (* GstValueUnionFunc) (GValue *dest,
const GValue *value1, const GValue *value1,
const GValue *value2); const GValue *value2);
@ -336,8 +335,7 @@ typedef gint (* GstValueUnionFunc) (GValue *dest,
* *
* Returns: %TRUE if the values can intersect * Returns: %TRUE if the values can intersect
*/ */
/* FIXME: shouldn't the return value be gboolean ? */ typedef gboolean (* GstValueIntersectFunc) (GValue *dest,
typedef gint (* GstValueIntersectFunc) (GValue *dest,
const GValue *value1, const GValue *value1,
const GValue *value2); const GValue *value2);
@ -352,8 +350,7 @@ typedef gint (* GstValueIntersectFunc) (GValue *dest,
* *
* Returns: %TRUE if the subtraction is not empty * Returns: %TRUE if the subtraction is not empty
*/ */
/* FIXME: shouldn't the return value be gboolean ? */ typedef gboolean (* GstValueSubtractFunc) (GValue *dest,
typedef gint (* GstValueSubtractFunc) (GValue *dest,
const GValue *minuend, const GValue *minuend,
const GValue *subtrahend); const GValue *subtrahend);