Add section for typefind helper and add documentation for the old and the new function.

Original commit message from CVS:
* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt:
* libs/gst/base/gsttypefindhelper.c:
Add section for typefind helper and add documentation
for the old and the new function.
This commit is contained in:
Tim-Philipp Müller 2006-02-27 19:19:40 +00:00
parent 991aa71ffb
commit cc13a984eb
4 changed files with 29 additions and 6 deletions

View file

@ -1,3 +1,11 @@
2006-02-27 Tim-Philipp Müller <tim at centricular dot net>
* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt:
* libs/gst/base/gsttypefindhelper.c:
Add section for typefind helper and add documentation
for the old and the new function.
2006-02-27 Tim-Philipp Müller <tim at centricular dot net>
* libs/gst/base/gsttypefindhelper.c: (buf_helper_find_peek),

View file

@ -10,8 +10,7 @@
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
<!ENTITY GstBytestream SYSTEM "xml/gstbytestream.xml">
<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
@ -59,6 +58,7 @@
&GstAdapter;
&GstCollectPads;
&GstTypeFindHelper;
</chapter>

View file

@ -254,6 +254,15 @@ GST_PUSH_SRC_GET_CLASS
gst_push_src_get_type
</SECTION>
<SECTION>
<FILE>gsttypefindhelper</FILE>
<TITLE>GstTypeFindHelper</TITLE>
<INCLUDE>gst/base/gsttypefindhelper.h</INCLUDE>
gst_type_find_helper
gst_type_find_helper_for_buffer
<SUBSECTION Private>
</SECTION>
# net
<SECTION>
@ -351,7 +360,3 @@ gst_check_teardown_element
gst_check_teardown_sink_pad
gst_check_teardown_src_pad
</SECTION>
# misc
# TODO : add gsttypefindhelper

View file

@ -21,6 +21,16 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gsttypefindhelper
* @short_description: Utility functions for typefinding
*
* Utility functions for elements doing typefinding:
* gst_type_find_helper() does typefinding in pull mode, while
* gst_type_find_helper_for_buffer() is useful for elements needing to do
* typefinding in push mode from a chain function.
*/
#include <stdlib.h>
#include <string.h>