Make gstcheck stuff show up in docs (still needs to be documented properly though).

Original commit message from CVS:
* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt:
* libs/gst/check/gstbufferstraw.c:
Make gstcheck stuff show up in docs (still needs to
be documented properly though).

diff --git a/ChangeLog b/ChangeLog
index 6c7439f..dbf0fa1 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2006-08-17  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * docs/libs/gstreamer-libs-docs.sgml:
+       * docs/libs/gstreamer-libs-sections.txt:
+       * libs/gst/check/gstbufferstraw.c:
+         Make gstcheck stuff show up in docs (still needs to
+         be documented properly though).
+
 2006-08-16  Jan Schmidt  <thaytan@mad.scientist.com>
 
        * docs/gst/gstreamer-sections.txt:

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index fcaf4c4..9150d26 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -13,6 +13,7 @@
 <!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
 
 <!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
+<!ENTITY GstCheckBufferStraw SYSTEM "xml/gstcheckbufferstraw.xml">
 
 <!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
 <!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
@@ -90,6 +91,7 @@
       </para>
   
       &GstCheck;
+      &GstCheckBufferStraw;
     </chapter>
   </part>
 

diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 6799010..d607a8c 100644 (file)
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -353,10 +353,14 @@ GST_IS_NET_TIME_PROVIDER_CLASS
 <SUBSECTION Private>
 gst_net_time_provider_get_type
 </SECTION>
+
 <SECTION>
 <FILE>gstcheck</FILE>
 <TITLE>GstCheck</TITLE>
-<SUBSECTION Private>
+<INCLUDE>gst/check/gstcheck.h</INCLUDE>
+GST_START_TEST
+GST_END_TEST
+
 ASSERT_BUFFER_REFCOUNT
 ASSERT_CAPS_REFCOUNT
 ASSERT_CRITICAL
@@ -365,6 +369,28 @@ ASSERT_MINI_OBJECT_REFCOUNT
 ASSERT_OBJECT_REFCOUNT
 ASSERT_OBJECT_REFCOUNT_BETWEEN
 ASSERT_SET_STATE
+
+fail_unless_equals_int
+fail_unless_equals_string
+fail_unless_equals_uint64
+fail_unless_message_error
+
+assert_equals_int
+assert_equals_string
+assert_equals_uint64
+assert_message_error
+
+gst_check_init
+gst_check_message_error
+gst_check_setup_element
+gst_check_setup_sink_pad
+gst_check_setup_src_pad
+gst_check_teardown_element
+gst_check_teardown_sink_pad
+gst_check_teardown_src_pad
+gst_check_run_suite
+
+<SUBSECTION Private>
 MAIN_INIT
 MAIN_START_THREADS
 MAIN_START_THREAD_FUNCTION
@@ -376,8 +402,6 @@ THREAD_STARTED
 THREAD_SWITCH
 THREAD_SYNCHRONIZE
 THREAD_TEST_RUNNING
-GST_START_TEST
-GST_END_TEST
 
 sync_cond
 mutex
@@ -386,28 +410,14 @@ thread_list
 start_cond
 GST_CHECK_MAIN
 
-fail_unless_equals_int
-fail_unless_equals_string
-fail_unless_equals_uint64
-fail_unless_message_error
-
-assert_equals_int
-assert_equals_string
-assert_equals_uint64
-assert_message_error
-
 gst_check_chain_func
-gst_check_init
-gst_check_message_error
-gst_check_setup_element
-gst_check_setup_sink_pad
-gst_check_setup_src_pad
-gst_check_teardown_element
-gst_check_teardown_sink_pad
-gst_check_teardown_src_pad
 gst_check_abi_list
-gst_check_run_suite
+</SECTION>
 
+<SECTION>
+<FILE>gstcheckbufferstraw</FILE>
+<TITLE>GstBufferStraw</TITLE>
+<INCLUDE>gst/check/gstbufferstraw.h</INCLUDE>
 gst_buffer_straw_start_pipeline
 gst_buffer_straw_get_buffer
 gst_buffer_straw_stop_pipeline

diff --git a/libs/gst/check/gstbufferstraw.c b/libs/gst/check/gstbufferstraw.c
index e4cbce4..b84d044 100644 (file)
--- a/libs/gst/check/gstbufferstraw.c
+++ b/libs/gst/check/gstbufferstraw.c
@@ -20,6 +20,14 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:gstcheckbufferstraw
+ * @short_description: Buffer interception code for GStreamer unit tests
+ *
+ * These macros and functions are for internal use of the unit tests found
+ * inside the 'check' directories of various GStreamer packages.
+ */
+
 #include "gstbufferstraw.h"
 
 static GCond *cond = NULL;