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.

diff --git a/ChangeLog b/ChangeLog
index 5d01e0e..acb01df 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 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),
        (buf_helper_find_suggest), (type_find_factory_rank_cmp),
        (gst_type_find_helper_for_buffer):

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index 6559b41..bf73551 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -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>
 

diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 9f94a45..b2a1886 100644 (file)
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -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

diff --git a/libs/gst/base/gsttypefindhelper.c b/libs/gst/base/gsttypefindhelper.c
index 747190c..26328be 100644 (file)
--- a/libs/gst/base/gsttypefindhelper.c
+++ b/libs/gst/base/gsttypefindhelper.c
@@ -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>