From ed4d76a9f0cbae93e8fb5f6d95f6d9ecb1ff055e Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Fri, 10 Mar 2006 15:30:27 +0000 Subject: [PATCH] gdp: Fix docs for dataprocotol to not get the return types completely wrong for a fe... Original commit message from CVS: * libs/gst/dataprotocol/dataprotocol.c: Fix docs for dataprocotol to not get the return types completely wrong for a few functions. --- gst/gdp/dataprotocol.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/gst/gdp/dataprotocol.c b/gst/gdp/dataprotocol.c index 1316682..9598321 100644 --- a/gst/gdp/dataprotocol.c +++ b/gst/gdp/dataprotocol.c @@ -413,7 +413,7 @@ gst_dp_packet_from_event (const GstEvent * event, GstDPHeaderFlag flags, * Use this function if you want to pre-allocate a buffer based on the * packet header to read the packet payload in to. * - * Returns: %TRUE if the buffer was successfully created. + * Returns: A #GstBuffer if the buffer was successfully created, or NULL. */ GstBuffer * gst_dp_buffer_from_header (guint header_length, const guint8 * header) @@ -441,7 +441,8 @@ gst_dp_buffer_from_header (guint header_length, const guint8 * header) * * Creates a newly allocated #GstCaps from the given packet. * - * Returns: %TRUE if the caps was successfully created. + * Returns: A #GstCaps containing the caps represented in the packet, + * or NULL if the packet could not be converted. */ GstCaps * gst_dp_caps_from_packet (guint header_length, const guint8 * header, @@ -469,7 +470,8 @@ gst_dp_caps_from_packet (guint header_length, const guint8 * header, * * Creates a newly allocated #GstEvent from the given packet. * - * Returns: %TRUE if the event was successfully created. + * Returns: A #GstEvent if the event was successfully created, + * or NULL if an event could not be read from the payload. */ GstEvent * gst_dp_event_from_packet (guint header_length, const guint8 * header, -- 2.7.4