Small updates to various docs.

Original commit message from CVS:
* docs/manual/basics-pads.xml:
* docs/plugins/Makefile.am:
* docs/plugins/gstreamer-plugins-docs.sgml:
* docs/plugins/gstreamer-plugins-sections.txt:
* docs/pwg/advanced-clock.xml:
* docs/pwg/advanced-scheduling.xml:
* docs/pwg/advanced-types.xml:
* plugins/elements/gstfdsink.c:
* plugins/elements/gstfdsrc.c:
* plugins/elements/gstfdsrc.h:
* plugins/elements/gstidentity.c: (gst_identity_class_init):
* plugins/elements/gstidentity.h:
* plugins/elements/gstqueue.h:
* plugins/elements/gsttee.c:
* plugins/elements/gsttee.h:
* plugins/elements/gsttypefindelement.c:
(gst_type_find_element_class_init):
* plugins/elements/gsttypefindelement.h:
Small updates to various docs.
Added core plugins to docs.

diff --git a/ChangeLog b/ChangeLog
index a8b6ed7eb82d0a6670e42c0bb262ae0c343a2560..2635f35ae0176d09f982042f17d1083b3e529ca3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,26 @@
+2006-01-04  Wim Taymans  <wim@fluendo.com>
+
+       * docs/manual/basics-pads.xml:
+       * docs/plugins/Makefile.am:
+       * docs/plugins/gstreamer-plugins-docs.sgml:
+       * docs/plugins/gstreamer-plugins-sections.txt:
+       * docs/pwg/advanced-clock.xml:
+       * docs/pwg/advanced-scheduling.xml:
+       * docs/pwg/advanced-types.xml:
+       * plugins/elements/gstfdsink.c:
+       * plugins/elements/gstfdsrc.c:
+       * plugins/elements/gstfdsrc.h:
+       * plugins/elements/gstidentity.c: (gst_identity_class_init):
+       * plugins/elements/gstidentity.h:
+       * plugins/elements/gstqueue.h:
+       * plugins/elements/gsttee.c:
+       * plugins/elements/gsttee.h:
+       * plugins/elements/gsttypefindelement.c:
+       (gst_type_find_element_class_init):
+       * plugins/elements/gsttypefindelement.h:
+       Small updates to various docs.
+       Added core plugins to docs.
+
 2006-01-03  Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * common/gst.supp:

diff --git a/docs/manual/basics-pads.xml b/docs/manual/basics-pads.xml
index 15cea0b94cb5508f1597825d42dbdd8c9723cd72..112fc154649c03a4d83bed414710c1d96141c611 100644 (file)
--- a/docs/manual/basics-pads.xml
+++ b/docs/manual/basics-pads.xml
@@ -195,7 +195,7 @@ link_to_multiplexer (GstPad     *tolink_pad,
       Since the pads play a very important role in how the element is
       viewed by the outside world, a mechanism is implemented to describe
       the data that can flow or currently flows through the pad by using
-      capabilities. Here,w e will briefly describe what capabilities are
+      capabilities. Here, we will briefly describe what capabilities are
       and how to use them, enough to get an understanding of the concept.
       For an in-depth look into capabilities and a list of all capabilities
       defined in &GStreamer;, see the <ulink type="http"
@@ -381,7 +381,7 @@ Pad Templates:
           Metadata: by reading the capabilities from a pad, applications
           can provide information about the type of media that is being
           streamed over the pad, which is information about the stream
-          thatis currently being played back.
+          that is currently being played back.
         </para>
       </listitem>
       <listitem>

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index b32ff6835983bba704ae8bc1c920d8147be6e035..8bfa8cfbbe5b855ffb0e5adb7776ccd9e9aa3439 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -76,9 +76,13 @@ IGNORE_CFILES =
 EXTRA_HFILES = \
        $(top_srcdir)/plugins/elements/gstfakesrc.h \
        $(top_srcdir)/plugins/elements/gstfakesink.h \
+       $(top_srcdir)/plugins/elements/gstfdsrc.h \
        $(top_srcdir)/plugins/elements/gstfilesrc.h \
        $(top_srcdir)/plugins/elements/gstfilesink.h \
-       $(top_srcdir)/plugins/elements/gstqueue.h
+       $(top_srcdir)/plugins/elements/gstidentity.h \
+       $(top_srcdir)/plugins/elements/gstqueue.h \
+       $(top_srcdir)/plugins/elements/gsttypefindelement.h \
+       $(top_srcdir)/plugins/elements/gsttee.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES =

diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml
index 90a60d2f2a572caf0cdfb48e81a99bafb26faec8..b34ba01bda5362a443cd17e9dcb19032ef558585 100644 (file)
--- a/docs/plugins/gstreamer-plugins-docs.sgml
+++ b/docs/plugins/gstreamer-plugins-docs.sgml
@@ -14,9 +14,13 @@
     <title>gstreamer Elements</title>
     <xi:include href="xml/element-fakesrc.xml" />
     <xi:include href="xml/element-fakesink.xml" />
+    <xi:include href="xml/element-fdsrc.xml" />
     <xi:include href="xml/element-filesrc.xml" />
     <xi:include href="xml/element-filesink.xml" />
+    <xi:include href="xml/element-identity.xml" />
     <xi:include href="xml/element-queue.xml" />
+    <xi:include href="xml/element-tee.xml" />
+    <xi:include href="xml/element-typefind.xml" />
   </chapter>
 
   <chapter>

diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt
index c0a8e5d0e5adf20e378d52bc7e867e6d199dd77d..c750c9318085901f095fa0b86ca630e5e395f6f8 100644 (file)
--- a/docs/plugins/gstreamer-plugins-sections.txt
+++ b/docs/plugins/gstreamer-plugins-sections.txt
@@ -34,6 +34,20 @@ GST_IS_FAKE_SINK_CLASS
 gst_fake_sink_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-fdsrc</FILE>
+<TITLE>fdsrc</TITLE>
+GstFdSrc
+<SUBSECTION Standard>
+GstFdSrcClass
+GST_FD_SRC
+GST_IS_FD_SRC
+GST_TYPE_FD_SRC
+GST_FD_SRC_CLASS
+GST_IS_FD_SRC_CLASS
+<SUBSECTION Private>
+gst_fd_src_get_type
+</SECTION>
 
 <SECTION>
 <FILE>element-filesrc</FILE>
@@ -66,6 +80,21 @@ GST_IS_FILE_SINK_CLASS
 gst_file_sink_get_type
 </SECTION>
 
+<SECTION>
+<FILE>element-identity</FILE>
+<TITLE>identity</TITLE>
+GstIdentity
+<SUBSECTION Standard>
+GstIdentityClass
+GST_IDENTITY
+GST_IS_IDENTITY
+GST_TYPE_IDENTITY
+GST_IDENTITY_CLASS
+GST_IS_IDENTITY_CLASS
+<SUBSECTION Private>
+gst_identity_get_type
+</SECTION>
+
 <SECTION>
 <FILE>element-queue</FILE>
 <TITLE>queue</TITLE>
@@ -81,4 +110,35 @@ GST_TYPE_QUEUE
 <SUBSECTION Private>
 gst_queue_get_type
 </SECTION>
+
+<SECTION>
+<FILE>element-typefind</FILE>
+<TITLE>typefind</TITLE>
+GstTypeFindElement
 <SUBSECTION Standard>
+GstTypeFindElementClass
+GST_TYPE_FIND_ELEMENT
+GST_IS_TYPE_FIND_ELEMENT
+GST_TYPE_TYPE_FIND_ELEMENT
+GST_TYPE_FIND_ELEMENT_CLASS
+GST_IS_TYPE_FIND_ELEMENT_CLASS
+GST_TYPE_FIND_ELEMENT_GET_CLASS
+<SUBSECTION Private>
+gst_type_find_element_get_type
+</SECTION>
+
+<SECTION>
+<FILE>element-tee</FILE>
+<TITLE>tee</TITLE>
+GstTee
+<SUBSECTION Standard>
+GstTeeClass
+GST_TEE
+GST_IS_TEE
+GST_TYPE_TEE
+GST_TEE_CLASS
+GST_IS_TEE_CLASS
+<SUBSECTION Private>
+gst_tee_get_type
+</SECTION>
+

diff --git a/docs/pwg/advanced-clock.xml b/docs/pwg/advanced-clock.xml
index 7b0ef56eae28b740dd4d1dd5befcfe6f4232d1f9..d03699e2a21babc3ca3b713179395464b17fe998 100644 (file)
--- a/docs/pwg/advanced-clock.xml
+++ b/docs/pwg/advanced-clock.xml
@@ -4,7 +4,7 @@
   <para>
     When playing complex media, each sound and video sample must be played in a
     specific order at a specific time. For this purpose, GStreamer provides a
-    syncrhonization mechanism.
+    synchronization mechanism.
   </para>
 
   <sect1 id="section-clock-time-types" xreflabel="Types of time"> 

diff --git a/docs/pwg/advanced-scheduling.xml b/docs/pwg/advanced-scheduling.xml
index f9b3b658c6039f241dd0baddbf208de39e6da5c4..2aab6909e1a71bc51f13aff4da12c7a7731b20fe 100644 (file)
--- a/docs/pwg/advanced-scheduling.xml
+++ b/docs/pwg/advanced-scheduling.xml
@@ -47,7 +47,7 @@
           If all pads of an element are assigned to do
           <quote>push</quote>-based scheduling, then this means that data
           will be pushed by upstream elements to this element using the
-          sinkpads <function>_chain ()</function>-function. Pprerequisites
+          sinkpads <function>_chain ()</function>-function. Prerequisites
           for this scheduling mode are that a chain-function was set for
           each sinkpad using<function>gst_pad_set_chain_function ()</function>
           and that all downstream elements operate in the same mode. Pads are

diff --git a/docs/pwg/advanced-types.xml b/docs/pwg/advanced-types.xml
index 8e179f9e56c0655a61883a63fd7db72e2af4f625..b7225bea31842fab4e937ddbae80b8ccb3a52715 100644 (file)
--- a/docs/pwg/advanced-types.xml
+++ b/docs/pwg/advanced-types.xml
@@ -331,25 +331,6 @@ plugin_init (GstPlugin *plugin)
               The amount of bits used and allocated per sample.
             </entry>
           </row>
-          <row>
-            <entry morerows="1">buffer-frames</entry>
-            <entry morerows="1">integer</entry>
-            <entry morerows="1">Any</entry>
-            <entry>
-              The number of frames per buffer. The reason for this property
-              is that the element does not need to reuse buffers or use data
-              spanned over multiple buffers, so this property - when used
-              rightly - will decrease latency.
-           </entry>
-         </row>
-          <row>
-           <entry>
-              Note that some people think that this property is very ugly, 
-             whereas others think it is vital for the use of &GStreamer; in 
-             professional audio applications. The special value zero is 
-             reserved and implies that size is variable between buffers.
-           </entry>
-          </row>
 
           <!-- ############ subtitle ############# -->
 
@@ -750,14 +731,14 @@ plugin_init (GstPlugin *plugin)
           </row>
           <row>
             <entry>framerate</entry>
-            <entry>double</entry>
-            <entry>greater than 0</entry>
+            <entry>fraction</entry>
+            <entry>greater or equal 0</entry>
             <entry>
               The (average) framerate in frames per second. Note that this
               property does not guarantee in <emphasis>any</emphasis> way that
               it will actually come close to this value. If you need a fixed
               framerate, please use an element that provides that (such as
-              <quote>videodrop</quote>).
+              <quote>videodrop</quote>). 0 means a variable framerate.
             </entry>
           </row>
 

diff --git a/plugins/elements/gstfdsink.c b/plugins/elements/gstfdsink.c
index 3652dce3dc938721d46935a52403140cc9c65be5..da88c85ab7e5c4ab4185be6c09951b934f6e297f 100644 (file)
--- a/plugins/elements/gstfdsink.c
+++ b/plugins/elements/gstfdsink.c
@@ -20,6 +20,14 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-fdsink
+ * @short_description: write to a unix file descriptor
+ * @see_also: #GstFdSrc
+ *
+ * Write data to a unix file descriptor.
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif

diff --git a/plugins/elements/gstfdsrc.c b/plugins/elements/gstfdsrc.c
index 1c9c8f9f83a378ac36ce28147ba05115cc50cb72..bd02f5728d74893aad18f8f73747eb4b5c2c95f3 100644 (file)
--- a/plugins/elements/gstfdsrc.c
+++ b/plugins/elements/gstfdsrc.c
@@ -20,6 +20,14 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-fdsrc
+ * @short_description: read from a unix file descriptor
+ * @see_also: #GstFdSink
+ *
+ * Read data from a unix file descriptor.
+ */
+
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/elements/gstfdsrc.h b/plugins/elements/gstfdsrc.h
index f780fa42f2495dc5da25c62abe7c2cd8ce8c93f7..f330fc22524cbc6c629f0e387c02fc8cfb0fd2e1 100644 (file)
--- a/plugins/elements/gstfdsrc.h
+++ b/plugins/elements/gstfdsrc.h
@@ -46,9 +46,15 @@ G_BEGIN_DECLS
 typedef struct _GstFdSrc GstFdSrc;
 typedef struct _GstFdSrcClass GstFdSrcClass;
 
+/**
+ * GstFdSrc:
+ *
+ * Opaque #GstFdSrc data structure
+ */
 struct _GstFdSrc {
   GstPushSrc element;
 
+  /*< private >*/
   /* new_fd is copied to fd on READY->PAUSED */
   gint new_fd;
 

diff --git a/plugins/elements/gstidentity.c b/plugins/elements/gstidentity.c
index 7b580762a5f089cb6928ab2482ffb3569bf44b2a..2158cb97fd27f4fd7afc0ae5f563cb28a0e14fb0 100644 (file)
--- a/plugins/elements/gstidentity.c
+++ b/plugins/elements/gstidentity.c
@@ -208,6 +208,14 @@ gst_identity_class_init (GstIdentityClass * klass)
           "Verify that the stream is time- and data-contiguous",
           DEFAULT_CHECK_PERFECT, G_PARAM_READWRITE));
 
+   /**
+   * GstIdentity::handoff:
+   * @identity: the identity instance
+   * @buffer: the buffer that just has been received
+   * @pad: the pad that received it
+   *
+   * This signal gets emitted before passing the buffer downstream.
+   */
   gst_identity_signals[SIGNAL_HANDOFF] =
       g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
       G_STRUCT_OFFSET (GstIdentityClass, handoff), NULL, NULL,

diff --git a/plugins/elements/gstidentity.h b/plugins/elements/gstidentity.h
index b92b473399a14cf721613cf83fa354c540f92133..b065898436e44b7d81df8a1b31bae536012ff7af 100644 (file)
--- a/plugins/elements/gstidentity.h
+++ b/plugins/elements/gstidentity.h
@@ -45,9 +45,15 @@ G_BEGIN_DECLS
 typedef struct _GstIdentity GstIdentity;
 typedef struct _GstIdentityClass GstIdentityClass;
 
+/**
+ * GstIdentity:
+ *
+ * Opaque #GstIdentity data structure
+ */
 struct _GstIdentity {
   GstBaseTransform      element;
 
+  /*< private >*/
   GstClockID     clock_id;
   gint                  error_after;
   gfloat        drop_probability;

diff --git a/plugins/elements/gstqueue.h b/plugins/elements/gstqueue.h
index 22315b0379fabbd8a9883033f042aa3f9a244a42..d121e4d978678687f672fedc0b3bab3ae921bfd1 100644 (file)
--- a/plugins/elements/gstqueue.h
+++ b/plugins/elements/gstqueue.h
@@ -24,8 +24,7 @@
 #ifndef __GST_QUEUE_H__
 #define __GST_QUEUE_H__
 
-
-#include <gst/gstelement.h>
+#include <gst/gst.h>
 
 G_BEGIN_DECLS
 

diff --git a/plugins/elements/gsttee.c b/plugins/elements/gsttee.c
index e90b4903d9fe783c473490b92aaeb4dbc1ced634..811ac15aa6527b30996a106385b51b22f5da9608 100644 (file)
--- a/plugins/elements/gsttee.c
+++ b/plugins/elements/gsttee.c
@@ -21,6 +21,14 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-tee
+ * @short_description: 1-to-N pipe fitting
+ * @see_also: #GstIdentity
+ *
+ * Split data to multiple pads.
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif

diff --git a/plugins/elements/gsttee.h b/plugins/elements/gsttee.h
index f358ba4a82e1a0de09286b12a0b34af9bc0382db..fa88677b6a71758c53e71aefa631716fc772125d 100644 (file)
--- a/plugins/elements/gsttee.h
+++ b/plugins/elements/gsttee.h
@@ -43,9 +43,15 @@ G_BEGIN_DECLS
 typedef struct _GstTee                 GstTee;
 typedef struct _GstTeeClass    GstTeeClass;
 
+/**
+ * GstTee:
+ *
+ * Opaque #GstTee data structure.
+ */
 struct _GstTee {
   GstElement element;
 
+  /*< private >*/
   GstPad *sinkpad;
 
   gboolean silent;

diff --git a/plugins/elements/gsttypefindelement.c b/plugins/elements/gsttypefindelement.c
index 30fa1b9e9e0e3924e3ce9df2c44d7c1cefe39330..e7024cced16e634056543c265d2870c9a0f32dcc 100644 (file)
--- a/plugins/elements/gsttypefindelement.c
+++ b/plugins/elements/gsttypefindelement.c
@@ -191,7 +191,15 @@ gst_type_find_element_class_init (GstTypeFindElementClass * typefind_class)
       g_param_spec_uint ("maximum", _("maximum"),
           "probability to stop typefinding", GST_TYPE_FIND_MINIMUM,
           GST_TYPE_FIND_MAXIMUM, GST_TYPE_FIND_MAXIMUM, G_PARAM_READWRITE));
-
+  /**
+   * GstTypeFindElement::have-type:
+   * @typefind: the typefind instance
+   * @probability: the probability of the type found
+   * @caps: the caps of the type found
+   *
+   * This signal gets emitted when the type and its probability has 
+   * been found.
+   */
   gst_type_find_element_signals[HAVE_TYPE] = g_signal_new ("have_type",
       G_TYPE_FROM_CLASS (typefind_class), G_SIGNAL_RUN_LAST,
       G_STRUCT_OFFSET (GstTypeFindElementClass, have_type), NULL, NULL,

diff --git a/plugins/elements/gsttypefindelement.h b/plugins/elements/gsttypefindelement.h
index 751c488cc43de11f2bedce49dc13131e052ef05f..3ef30ccefd0e70d4f61013846858ffc42e9fe84b 100644 (file)
--- a/plugins/elements/gsttypefindelement.h
+++ b/plugins/elements/gsttypefindelement.h
@@ -42,6 +42,11 @@ G_BEGIN_DECLS
 typedef struct _GstTypeFindElement             GstTypeFindElement;
 typedef struct _GstTypeFindElementClass        GstTypeFindElementClass;
 
+/**
+ * GstTypeFindElement:
+ *
+ * Opaque #GstTypeFindElement data structure
+ */
 struct _GstTypeFindElement {
   GstElement           element;