libs/gst/base/gstadapter.c: Add some docs.

Original commit message from CVS:
* libs/gst/base/gstadapter.c:
Add some docs.
This commit is contained in:
Wim Taymans 2006-03-15 16:22:26 +00:00
parent d84e29915d
commit 006b34dc3f
2 changed files with 9 additions and 1 deletions

View file

@ -1,3 +1,8 @@
2006-03-15 Wim Taymans <wim@fluendo.com>
* libs/gst/base/gstadapter.c:
Add some docs.
2006-03-15 Tim-Philipp Müller <tim at centricular dot net>
* win32/common/libgstbase.def:

View file

@ -27,6 +27,9 @@
* a file. So if you have undefined buffer sizes and require a specific size,
* this object is for you.
*
* An adapter is created with gst_adapter_new(). It can be freed again with
* g_object_unref().
*
* The theory of operation is like this: All buffers received are put
* into the adapter using gst_adapter_push() and the data is then read back
* in chunks of the desired size using gst_adapter_peek(). After the data is
@ -152,7 +155,7 @@ gst_adapter_finalize (GObject * object)
/**
* gst_adapter_new:
*
* Creates a new #GstAdapter.
* Creates a new #GstAdapter. Free with g_object_unref().
*
* Returns: a new #GstAdapter
*/