reinstate plugin docs

Original commit message from CVS:
reinstate plugin docs

diff --git a/ChangeLog b/ChangeLog
index 8ad66aa..ec724a4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,19 @@
+2005-06-29  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * autogen.sh:
+       * configure.ac:
+       * docs/Makefile.am:
+       * docs/libs/Makefile.am:
+       * docs/libs/gst-plugins-libs-docs.sgml:
+       * docs/libs/gst-plugins-libs-sections.txt:
+       * docs/libs/gst-plugins-libs.types:
+       * docs/libs/tmpl/gstaudio.sgml:
+       * docs/libs/tmpl/gstcolorbalance.sgml:
+       * docs/libs/tmpl/gstringbuffer.sgml:
+       * gst-libs/gst/audio/gstringbuffer.c:
+       (gst_ringbuffer_set_callback):
+         reinstate gtk-doc docs for plugin libs
+
 2005-06-28  Wim Taymans  <wim@fluendo.com>
 
        * ext/ogg/gstoggdemux.c: (gst_ogg_pad_submit_packet),

diff --git a/autogen.sh b/autogen.sh
index 1996734..edfed2e 100755 (executable)
--- a/autogen.sh
+++ b/autogen.sh
@@ -25,7 +25,7 @@ then
 fi
 . common/gst-autogen.sh
 
-CONFIGURE_DEF_OPT='--enable-maintainer-mode --enable-plugin-builddir --enable-debug --enable-DEBUG'
+CONFIGURE_DEF_OPT='--enable-maintainer-mode --enable-plugin-builddir --enable-debug --enable-DEBUG --enable-gtk-doc'
 
 autogen_options $@
 

diff --git a/common b/common
index d6e46b2..2826306 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit d6e46b214fac0ecb46010ff522af2f7653e1c18e
+Subproject commit 2826306411790bf8aa9298922aa59b126897431f

diff --git a/configure.ac b/configure.ac
index 3233b9e..b5ae7c2 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -410,6 +410,10 @@ dnl ==========================================================================
 dnl ============================= sys plug-ins ================================
 dnl ==========================================================================
 
+echo
+AC_MSG_NOTICE([Checking libraries for plugins in sys/])
+echo
+
 dnl Check for X11
 translit(dnm, m, l) AM_CONDITIONAL(USE_X, true)
 GST_CHECK_FEATURE(X, [X libraries and plugins],
@@ -575,7 +579,9 @@ dnl let's try and sort them alphabetically, shall we ?
 
 if test "x$BUILD_EXTERNAL" = "xyes"; then
 
-AC_MSG_NOTICE(Checking for plug-in dependency libraries)
+echo
+AC_MSG_NOTICE([Checking libraries for plugins in ext/])
+echo
 
 dnl *** alsa ***
 translit(dnm, m, l) AM_CONDITIONAL(USE_ALSA, true)
@@ -783,6 +789,12 @@ if test "x$USE_DEBUG" = xyes; then
   GST_CFLAGS="$GST_CFLAGS -g"
 fi
 
+dnl ######################
+dnl # Checks for gtk-doc #
+dnl ######################
+
+GTK_DOC_CHECK([1.0])
+
 dnl #############################
 dnl # Set automake conditionals #
 dnl #############################
@@ -796,11 +808,8 @@ AM_CONDITIONAL(BROKEN,              test "$BROKEN" = "$xyes")
 
 AM_CONDITIONAL(HAVE_NASM,           test "x$HAVE_NASM" = "xyes")
 AM_CONDITIONAL(HAVE_GTK,            test "x$HAVE_GTK" = "xyes")
-AM_CONDITIONAL(HAVE_GTK_DOC,        $HAVE_GTK_DOC)
-AM_CONDITIONAL(BUILD_DOCS,          test "x$BUILD_DOCS" = "xyes")
 AM_CONDITIONAL(BUILD_TESTS,         test "x$BUILD_TESTS" = "xyes")
 AM_CONDITIONAL(BUILD_EXAMPLES,      test "x$BUILD_EXAMPLES" = "xyes")
-AM_CONDITIONAL(BUILD_PLUGIN_DOCS,   test "x$BUILD_PLUGIN_DOCS" = "xyes")
 AM_CONDITIONAL(HAVE_FIG2DEV_PNG,    $HAVE_FIG2DEV_PNG)
 AM_CONDITIONAL(HAVE_FIG2DEV_PDF,    $HAVE_FIG2DEV_PDF)
 AM_CONDITIONAL(HAVE_RAW1394,        test "x$HAVE_RAW1394" = "xyes")
@@ -918,15 +927,14 @@ pkgconfig/gstreamer-libs.pc
 pkgconfig/gstreamer-libs-uninstalled.pc
 pkgconfig/gstreamer-plugins.pc
 pkgconfig/gstreamer-plugins-uninstalled.pc
+docs/Makefile
+docs/libs/Makefile
+docs/version.entities
 po/Makefile.in
 common/Makefile
 common/m4/Makefile
 m4/Makefile
 )
-dnl disabled until it actually passes make distcheck
-dnl docs/Makefile
-dnl docs/libs/Makefile
-dnl docs/version.entities
 AC_OUTPUT
 
 echo -n "configure: *** Plug-ins that will be built :"

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 0f2972b..e9077ab 100644 (file)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,10 +1,10 @@
-if BUILD_DOCS
-SUBDIRS_DOCS = libs
+if ENABLE_GTK_DOC
+GTK_DOC_DIRS = libs
 else
-SUBDIRS_DOCS =
+GTK_DOC_DIRS =
 endif
 
-SUBDIRS = $(SUBDIRS_DOCS)
+SUBDIRS = $(GTK_DOC_DIRS)
 DIST_SUBDIRS = libs
 
 EXTRA_DIST = \

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 5890db0..73de5ae 100644 (file)
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -64,7 +64,9 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
 #SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
 #      $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
 #SCANOBJ_DEPS = $(top_builddir)/libs/gst/control/libgstcontrol-@GST_MAJORMINOR@.la
-SCANOBJ_DEPF =
+SCANOBJ_DEPS = \
+       $(top_builddir)/gst-libs/gst/colorbalance/libgstcolorbalance.la \
+       $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la
 
 # Header files to ignore when scanning.
 IGNORE_HFILES = 
@@ -80,8 +82,8 @@ extra_files =
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 # contains GtkObjects/GObjects and you want to document signals and properties.
-GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -I$(top_builddir)
-GTKDOC_LIBS = $(GST_OBJ_LIBS) $(SCANOBJ_DEPS)
+GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
+GTKDOC_LIBS = $(GST_BASE_LIBS) $(SCANOBJ_DEPS)
 
 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)

diff --git a/docs/libs/gst-plugins-libs-docs.sgml b/docs/libs/gst-plugins-libs-docs.sgml
index 036478d..d96821a 100644 (file)
--- a/docs/libs/gst-plugins-libs-docs.sgml
+++ b/docs/libs/gst-plugins-libs-docs.sgml
@@ -3,7 +3,12 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % version-entities SYSTEM "version.entities">
 %version-entities;
+
+<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
+<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
 <!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
+<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
+
 ]>
 <book id="index">
   <bookinfo>
@@ -12,6 +17,9 @@
 
   <chapter>
     <title>GStreamer Plugin Libraries</title>
+    &GstAudio;
+    &GstRingBuffer;
+    &GstColorBalance;
     &GstGConf;
   </chapter>
 </book>

diff --git a/docs/libs/gst-plugins-libs-sections.txt b/docs/libs/gst-plugins-libs-sections.txt
index 9b77029..05d8478 100644 (file)
--- a/docs/libs/gst-plugins-libs-sections.txt
+++ b/docs/libs/gst-plugins-libs-sections.txt
@@ -1,5 +1,57 @@
 <SECTION>
+<FILE>gstaudio</FILE>
+<INCLUDE>gst-libs/gst/audio/audio.h</INCLUDE>
+GstAudioFieldFlag
+gst_audio_frame_byte_size
+gst_audio_frame_length
+gst_audio_frame_rate
+gst_audio_length
+gst_audio_highest_sample_value
+gst_audio_is_buffer_framed
+gst_audio_structure_set_int
+</SECTION>
+
+<FILE>gstcolorbalance</FILE>
+<INCLUDE>gst-libs/gst/colorbalance/colorbalance.h</INCLUDE>
+GstColorBalance
+GstColorBalanceClass
+gst_color_balance_list_channels
+gst_color_balance_get_value
+gst_color_balance_set_value
+gst_color_balance_value_changed
+</SECTION>
+
+<SECTION>
 <FILE>gstgconf</FILE>
 <INCLUDE>gst-libs/gst/gconf/gconf.h</INCLUDE>
 gst_gconf_get_string
 </SECTION>
+
+<SECTION>
+<FILE>gstringbuffer</FILE>
+<INCLUDE>gst-libs/gst/audio/gstringbuffer.h</INCLUDE>
+GstRingBuffer
+GstRingBufferClass
+
+gst_ringbuffer_set_callback
+
+gst_ringbuffer_acquire
+gst_ringbuffer_release
+gst_ringbuffer_is_acquired
+
+gst_ringbuffer_play
+gst_ringbuffer_pause
+gst_ringbuffer_stop
+
+gst_ringbuffer_delay
+gst_ringbuffer_played_samples
+gst_ringbuffer_set_sample
+gst_ringbuffer_commit
+
+gst_ringbuffer_prepare_read
+gst_ringbuffer_clear
+gst_ringbuffer_advance
+
+</SECTION>
+
+

diff --git a/docs/libs/gst-plugins-libs.types b/docs/libs/gst-plugins-libs.types
index e69de29..0b17471 100644 (file)
--- a/docs/libs/gst-plugins-libs.types
+++ b/docs/libs/gst-plugins-libs.types
@@ -0,0 +1,9 @@
+#include <gst/gst.h>
+
+#include <gst/colorbalance/colorbalance.h>
+#include <gst/audio/gstringbuffer.h>
+
+gst_ringbuffer_get_type
+
+gst_color_balance_get_type
+gst_color_balance_channel_get_type

diff --git a/docs/libs/tmpl/gstaudio.sgml b/docs/libs/tmpl/gstaudio.sgml
new file mode 100644 (file)
index 0000000..a0f9ad9
--- /dev/null
+++ b/docs/libs/tmpl/gstaudio.sgml
@@ -0,0 +1,97 @@
+<!-- ##### SECTION Title ##### -->
+gstaudio
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM GstAudioFieldFlag ##### -->
+<para>
+
+</para>
+
+@GST_AUDIO_FIELD_RATE: 
+@GST_AUDIO_FIELD_CHANNELS: 
+@GST_AUDIO_FIELD_ENDIANNESS: 
+@GST_AUDIO_FIELD_WIDTH: 
+@GST_AUDIO_FIELD_DEPTH: 
+@GST_AUDIO_FIELD_SIGNED: 
+@GST_AUDIO_FIELD_BUFFER_FRAMES: 
+
+<!-- ##### FUNCTION gst_audio_frame_byte_size ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_frame_length ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_frame_rate ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_length ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_highest_sample_value ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_is_buffer_framed ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_structure_set_int ##### -->
+<para>
+
+</para>
+
+@structure: 
+@flag: 
+
+

diff --git a/docs/libs/tmpl/gstcolorbalance.sgml b/docs/libs/tmpl/gstcolorbalance.sgml
new file mode 100644 (file)
index 0000000..37e2c51
--- /dev/null
+++ b/docs/libs/tmpl/gstcolorbalance.sgml
@@ -0,0 +1,153 @@
+<!-- ##### SECTION Title ##### -->
+gstcolorbalance
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### ENUM GstAudioFieldFlag ##### -->
+<para>
+
+</para>
+
+@GST_AUDIO_FIELD_RATE: 
+@GST_AUDIO_FIELD_CHANNELS: 
+@GST_AUDIO_FIELD_ENDIANNESS: 
+@GST_AUDIO_FIELD_WIDTH: 
+@GST_AUDIO_FIELD_DEPTH: 
+@GST_AUDIO_FIELD_SIGNED: 
+@GST_AUDIO_FIELD_BUFFER_FRAMES: 
+
+<!-- ##### FUNCTION gst_audio_frame_byte_size ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_frame_length ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_frame_rate ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_length ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_highest_sample_value ##### -->
+<para>
+
+</para>
+
+@pad: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_is_buffer_framed ##### -->
+<para>
+
+</para>
+
+@pad: 
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_audio_structure_set_int ##### -->
+<para>
+
+</para>
+
+@structure: 
+@flag: 
+
+
+<!-- ##### STRUCT GstColorBalance ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GstColorBalanceClass ##### -->
+<para>
+
+</para>
+
+@klass: 
+@balance_type: 
+@list_channels: 
+@set_value: 
+@get_value: 
+@value_changed: 
+@_gst_reserved: 
+
+<!-- ##### FUNCTION gst_color_balance_list_channels ##### -->
+<para>
+
+</para>
+
+@balance: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_color_balance_get_value ##### -->
+<para>
+
+</para>
+
+@balance: 
+@channel: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_color_balance_set_value ##### -->
+<para>
+
+</para>
+
+@balance: 
+@channel: 
+@value: 
+
+
+<!-- ##### FUNCTION gst_color_balance_value_changed ##### -->
+<para>
+
+</para>
+
+@balance: 
+@channel: 
+@value: 
+
+

diff --git a/docs/libs/tmpl/gstringbuffer.sgml b/docs/libs/tmpl/gstringbuffer.sgml
new file mode 100644 (file)
index 0000000..8bc7be3
--- /dev/null
+++ b/docs/libs/tmpl/gstringbuffer.sgml
@@ -0,0 +1,182 @@
+<!-- ##### SECTION Title ##### -->
+gstringbuffer
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GstRingBuffer ##### -->
+<para>
+
+</para>
+
+@cond: 
+@acquired: 
+@data: 
+@spec: 
+@segstate: 
+@samples_per_seg: 
+@empty_seg: 
+@state: 
+@segplayed: 
+@waiting: 
+
+<!-- ##### STRUCT GstRingBufferClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+@acquire: 
+@release: 
+@play: 
+@pause: 
+@resume: 
+@stop: 
+@delay: 
+
+<!-- ##### FUNCTION gst_ringbuffer_set_callback ##### -->
+<para>
+
+</para>
+
+@buf: 
+@cb: 
+@user_data: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_acquire ##### -->
+<para>
+
+</para>
+
+@buf: 
+@spec: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_release ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_is_acquired ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_play ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_pause ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_stop ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_delay ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_played_samples ##### -->
+<para>
+
+</para>
+
+@buf: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_set_sample ##### -->
+<para>
+
+</para>
+
+@buf: 
+@sample: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_commit ##### -->
+<para>
+
+</para>
+
+@buf: 
+@sample: 
+@data: 
+@len: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_prepare_read ##### -->
+<para>
+
+</para>
+
+@buf: 
+@segment: 
+@readptr: 
+@len: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_clear ##### -->
+<para>
+
+</para>
+
+@buf: 
+@segment: 
+
+
+<!-- ##### FUNCTION gst_ringbuffer_advance ##### -->
+<para>
+
+</para>
+
+@buf: 
+@advance: 
+
+

diff --git a/gst-libs/gst/audio/gstringbuffer.c b/gst-libs/gst/audio/gstringbuffer.c
index 36df08e..37f1c2d 100644 (file)
--- a/gst-libs/gst/audio/gstringbuffer.c
+++ b/gst-libs/gst/audio/gstringbuffer.c
@@ -110,7 +110,7 @@ gst_ringbuffer_finalize (GObject * object)
  * gst_ringbuffer_set_callback:
  * @buf: the #GstRingBuffer to set the callback on
  * @cb: the callback to set
- * @data: use data passed to the callback
+ * @user_data: user data passed to the callback
  *
  * Sets the given callback function on the buffer. This function
  * will be called every time a segment has been written to a device.
@@ -119,7 +119,7 @@ gst_ringbuffer_finalize (GObject * object)
  */
 void
 gst_ringbuffer_set_callback (GstRingBuffer * buf, GstRingBufferCallback cb,
-    gpointer data)
+    gpointer user_data)
 {
   g_return_if_fail (buf != NULL);