gst/gstelement.c: Clarify the use of _release_request_pad() and _get_request_pad() a bit better.

Original commit message from CVS:
* gst/gstelement.c:
Clarify the use of _release_request_pad() and
_get_request_pad() a bit better.
* libs/gst/base/gstadapter.c: (gst_adapter_peek),
(gst_adapter_take_buffer):
Fix some doc and comment typos.
This commit is contained in:
Wim Taymans 2006-05-30 15:53:40 +00:00
parent 1b44804c45
commit 2a51528a41
4 changed files with 21 additions and 4 deletions

View file

@ -1,3 +1,13 @@
2006-05-30 Wim Taymans <wim@fluendo.com>
* gst/gstelement.c:
Clarify the use of _release_request_pad() and
_get_request_pad() a bit better.
* libs/gst/base/gstadapter.c: (gst_adapter_peek),
(gst_adapter_take_buffer):
Fix some doc and comment typos.
2006-05-30 Thomas Vander Stichele <thomas (at) apestaart (dot) org> 2006-05-30 Thomas Vander Stichele <thomas (at) apestaart (dot) org>
* docs/gst/gstreamer-sections.txt: * docs/gst/gstreamer-sections.txt:

2
common

@ -1 +1 @@
Subproject commit 2f06c5cbc778e158d2429b09efc6740ff5281295 Subproject commit b0fd90b1cfb51107e8a511a1f3983a06bdd18638

View file

@ -675,6 +675,11 @@ no_direction:
* Removes @pad from @element. @pad will be destroyed if it has not been * Removes @pad from @element. @pad will be destroyed if it has not been
* referenced elsewhere. * referenced elsewhere.
* *
* This function is used by plugin developers and should not be used
* by applications. Pads that were dynamically requested from elements
* with gst_element_get_request_pad() should be released with the
* gst_element_release_request_pad() function instead.
*
* Returns: TRUE if the pad could be removed. Can return FALSE if the * Returns: TRUE if the pad could be removed. Can return FALSE if the
* pad is not belonging to the provided element. * pad is not belonging to the provided element.
* *
@ -847,7 +852,8 @@ gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
* @name: the name of the request #GstPad to retrieve. * @name: the name of the request #GstPad to retrieve.
* *
* Retrieves a pad from the element by name. This version only retrieves * Retrieves a pad from the element by name. This version only retrieves
* request pads. * request pads. The pad should be released with
* gst_element_release_request_pad().
* *
* Returns: requested #GstPad if found, otherwise NULL. Unref after usage. * Returns: requested #GstPad if found, otherwise NULL. Unref after usage.
*/ */

View file

@ -1,5 +1,6 @@
/* GStreamer /* GStreamer
* Copyright (C) 2004 Benjamin Otte <otte@gnome.org> * Copyright (C) 2004 Benjamin Otte <otte@gnome.org>
* 2005 Wim Taymans <wim@fluendo.com>
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public * modify it under the terms of the GNU Library General Public
@ -89,7 +90,7 @@
* access the buffer later. The adapter will never modify the data in the * access the buffer later. The adapter will never modify the data in the
* buffer pushed in it. * buffer pushed in it.
* *
* Last reviewed on 2006-03-07 (0.10.4). * Last reviewed on 2006-04-04 (0.10.6).
*/ */
@ -236,7 +237,7 @@ gst_adapter_peek (GstAdapter * adapter, guint size)
g_return_val_if_fail (size > 0, NULL); g_return_val_if_fail (size > 0, NULL);
/* we don't have enough data, return NULL. This is unlikely /* we don't have enough data, return NULL. This is unlikely
* as one usually does a _available() first instead of peeking a * as one usually does an _available() first instead of peeking a
* random size. */ * random size. */
if (G_UNLIKELY (size > adapter->size)) if (G_UNLIKELY (size > adapter->size))
return NULL; return NULL;