diff options
| author | Michael Smith <msmith@xiph.org> | 2006-03-10 15:30:27 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.net> | 2012-09-11 01:54:38 +0100 |
| commit | cfcef37b4f787bf140733f149be449ac1d9deced (patch) | |
| tree | 3b756222380fa596fa67d97a3cb022b340904a06 /gst | |
| parent | fc5ec74824df179d1c5c76ce37429dad0a5a05fe (diff) | |
| download | gstreamer-plugins-bad-cfcef37b4f787bf140733f149be449ac1d9deced.tar.gz | |
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.
Diffstat (limited to 'gst')
| -rw-r--r-- | gst/gdp/dataprotocol.c | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/gst/gdp/dataprotocol.c b/gst/gdp/dataprotocol.c index 1316682b3..9598321e4 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, |