plugins/elements/: Remove short_description. Add basic docs for gsttypefindelement.

Original commit message from CVS:
* plugins/elements/gstcapsfilter.c:
* plugins/elements/gstfakesink.c:
* plugins/elements/gstfakesrc.c:
* plugins/elements/gstfdsink.c:
* plugins/elements/gstfdsrc.c:
* plugins/elements/gstfilesink.c:
* plugins/elements/gstfilesrc.c:
* plugins/elements/gstidentity.c:
* plugins/elements/gstmultiqueue.c:
* plugins/elements/gstqueue.c:
* plugins/elements/gsttee.c:
* plugins/elements/gsttypefindelement.c:
Remove short_description. Add basic docs for gsttypefindelement.
Simplify markup for fakesrc/fdsrc.

diff --git a/ChangeLog b/ChangeLog
index cb086abbfcd9ee6e254d0b913f04037560c58169..3227f09aeb3d3547fa81d8eff56fe3c4f3837a03 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2008-06-20  Stefan Kost  <ensonic@users.sf.net>
+
+       * plugins/elements/gstcapsfilter.c:
+       * plugins/elements/gstfakesink.c:
+       * plugins/elements/gstfakesrc.c:
+       * plugins/elements/gstfdsink.c:
+       * plugins/elements/gstfdsrc.c:
+       * plugins/elements/gstfilesink.c:
+       * plugins/elements/gstfilesrc.c:
+       * plugins/elements/gstidentity.c:
+       * plugins/elements/gstmultiqueue.c:
+       * plugins/elements/gstqueue.c:
+       * plugins/elements/gsttee.c:
+       * plugins/elements/gsttypefindelement.c:
+         Remove short_description. Add basic docs for gsttypefindelement.
+         Simplify markup for fakesrc/fdsrc.
+
 2008-06-20  Wim Taymans  <wim.taymans@collabora.co.uk>
 
        * plugins/elements/gstfdsrc.c: (gst_fd_src_class_init):

diff --git a/plugins/elements/gstcapsfilter.c b/plugins/elements/gstcapsfilter.c
index edb17e70a7a1b09b6cb74db67b08c75557d65380..bae446122baf3329a71f9e20405d42c265c45215 100644 (file)
--- a/plugins/elements/gstcapsfilter.c
+++ b/plugins/elements/gstcapsfilter.c
@@ -21,7 +21,6 @@
  */
 /**
  * SECTION:element-capsfilter
- * @short_description: pass data though unmodified, but enforces format limmits
  *
  * The element does not modify data as such, but can enforce limmitations on the
  * data format.

diff --git a/plugins/elements/gstfakesink.c b/plugins/elements/gstfakesink.c
index 47e60e835341010a0f0e6f5a382fe85c0406536a..ba8402ae873354d55bee22d73468d484b323d7ee 100644 (file)
--- a/plugins/elements/gstfakesink.c
+++ b/plugins/elements/gstfakesink.c
@@ -21,7 +21,6 @@
  */
 /**
  * SECTION:element-fakesink
- * @short_description: black hole for data
  * @see_also: #GstFakeSrc
  *
  * Dummy sink that swallows everything.

diff --git a/plugins/elements/gstfakesrc.c b/plugins/elements/gstfakesrc.c
index 4d5d24f4f40b38149669cce36de8e5cfca7ed80b..3dd9499596a48f6af6966ac88d9ca08b19807c88 100644 (file)
--- a/plugins/elements/gstfakesrc.c
+++ b/plugins/elements/gstfakesrc.c
@@ -21,30 +21,23 @@
  */
 /**
  * SECTION:element-fakesrc
- * @short_description: Generate (meaningless) buffers
  * @see_also: #GstFakeSink
  *
- * <refsect2>
- * <para>
  * The fakesrc element is a multipurpose element that can generate
  * a wide range of buffers and can operate in various scheduling modes.
- * </para>
- * <para>
+ * 
  * It is mostly used as a testing element, one trivial example for testing
  * basic <application>GStreamer</application> core functionality is:
- * </para>
+ * 
+ * <refsect2>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch -v fakesrc num-buffers=5 ! fakesink
- * </programlisting>
- * This pipeline will push 5 empty buffers to the fakesink element and then
+ * ]| This pipeline will push 5 empty buffers to the fakesink element and then
  * sends an EOS.
- * </para>
- * <para>
- * Last reviewed on 2005-12-02 (0.9.7)
- * </para>
  * </refsect2>
+ * 
+ * Last reviewed on 2008-06-20 (0.10.21)
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/plugins/elements/gstfdsink.c b/plugins/elements/gstfdsink.c
index 14b723b9682ec8f9187aa65d8b4bf29b7b10b308..b11198fa95165a800dc9a7468be6eca1f77e61ed 100644 (file)
--- a/plugins/elements/gstfdsink.c
+++ b/plugins/elements/gstfdsink.c
@@ -22,7 +22,6 @@
 
 /**
  * SECTION:element-fdsink
- * @short_description: write to a unix file descriptor
  * @see_also: #GstFdSrc
  *
  * Write data to a unix file descriptor.

diff --git a/plugins/elements/gstfdsrc.c b/plugins/elements/gstfdsrc.c
index b8626a4dc09d34aa2915e02fcb46052dc0d348c0..4f6beb3c393dba08efe5f9a0598145fe400e868c 100644 (file)
--- a/plugins/elements/gstfdsrc.c
+++ b/plugins/elements/gstfdsrc.c
@@ -22,26 +22,15 @@
  */
 /**
  * SECTION:element-fdsrc
- * @short_description: read from a unix file descriptor
  * @see_also: #GstFdSink
  *
- * <refsect2>
- * <para>
  * Read data from a unix file descriptor.
- * </para>
- * <title>Examples</title>
- * <para>
- * Here is a simple pipeline to read from the standard input and dump the data
- * with a fakesink.
- * <programlisting>
- * gst-launch -v fdsrc ! fakesink dump=1
- * </programlisting>
+ * 
  * To generate data, enter some data on the console folowed by enter.
  * The above mentioned pipeline should dump data packets to the console.
- * </para>
- * <para>
- * If the <link linkend="GstFdSrc--timeout">timeout property</link> is set to a
- * value bigger than 0, fdsrc will generate an element message named
+ * 
+ * If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
+ * generate an element message named
  * <classname>&quot;GstFdSrcTimeout&quot;</classname>
  * if no data was recieved in the given timeout.
  * The message's structure contains one field:
@@ -54,11 +43,16 @@
  *   </para>
  * </listitem>
  * </itemizedlist>
- * </para>
- * <para>
- * Last reviewed on 2008-06-20 (0.10.21)
- * </para>
+ * 
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * echo "Hello GStreamer" | gst-launch -v fdsrc ! fakesink dump=true
+ * ]| A simple pipeline to read from the standard input and dump the data
+ * with a fakesink as hex ascii block.
  * </refsect2>
+ * 
+ * Last reviewed on 2008-06-20 (0.10.21)
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/plugins/elements/gstfilesink.c b/plugins/elements/gstfilesink.c
index 7116568552a902479e64efa2f9000907f5369de0..f17ba048de55488760543f24b7ecf32c7c203b53 100644 (file)
--- a/plugins/elements/gstfilesink.c
+++ b/plugins/elements/gstfilesink.c
@@ -22,7 +22,6 @@
  */
 /**
  * SECTION:element-filesink
- * @short_description: write stream to a file
  * @see_also: #GstFileSrc
  *
  * Write incoming data to a file in the local file system.

diff --git a/plugins/elements/gstfilesrc.c b/plugins/elements/gstfilesrc.c
index e9d60fd15e1a61dbfeecc8330f9e0241d95e3173..a01e61011032e49195d3e9cbaa6e07260ebf97ee 100644 (file)
--- a/plugins/elements/gstfilesrc.c
+++ b/plugins/elements/gstfilesrc.c
@@ -21,7 +21,6 @@
  */
 /**
  * SECTION:element-filesrc
- * @short_description: read from arbitrary point in a file
  * @see_also: #GstFileSrc
  *
  * Read data from a file in the local file system.

diff --git a/plugins/elements/gstidentity.c b/plugins/elements/gstidentity.c
index 096f944e3968eab570fe3bb2c25d60fe5eb103a3..5d62d821cb5e42342f967c11c951994e973f5895 100644 (file)
--- a/plugins/elements/gstidentity.c
+++ b/plugins/elements/gstidentity.c
@@ -22,7 +22,6 @@
  */
 /**
  * SECTION:element-identity
- * @short_description: pass data through without modification
  *
  * Dummy element that passes incomming data through unmodified. I has some
  * useful diagnostic functions, such as offset and timestamp checking.

diff --git a/plugins/elements/gstmultiqueue.c b/plugins/elements/gstmultiqueue.c
index 78bba70d8a87ecdcdaddeb0f01fa52517c585979..a787e06c400a061ef38b3e294164ce4997b3795e 100644 (file)
--- a/plugins/elements/gstmultiqueue.c
+++ b/plugins/elements/gstmultiqueue.c
@@ -23,7 +23,6 @@
 
 /**
  * SECTION:element-multiqueue
- * @short_description: Asynchronous data queues
  * @see_also: #GstQueue
  *
  * <refsect2>

diff --git a/plugins/elements/gstqueue.c b/plugins/elements/gstqueue.c
index 9a9d711f9fc6583a4fb92335be3aa32193525ba8..731a2ac1d72156832905a7842ef93bf5f01d96e0 100644 (file)
--- a/plugins/elements/gstqueue.c
+++ b/plugins/elements/gstqueue.c
@@ -24,7 +24,6 @@
 
 /**
  * SECTION:element-queue
- * @short_description: Simple asynchronous data queue.
  *
  * Data is queued until one of the limits specified by the
  * #GstQueue:max-size-buffers, #GstQueue:max-size-bytes and/or

diff --git a/plugins/elements/gsttee.c b/plugins/elements/gsttee.c
index f886b4b193cb935d736d1b7c21e61410a686d075..24cc4102e539d2737bd63829ad83cad63540ffbd 100644 (file)
--- a/plugins/elements/gsttee.c
+++ b/plugins/elements/gsttee.c
@@ -23,7 +23,6 @@
 
 /**
  * SECTION:element-tee
- * @short_description: 1-to-N pipe fitting
  * @see_also: #GstIdentity
  *
  * Split data to multiple pads.

diff --git a/plugins/elements/gsttypefindelement.c b/plugins/elements/gsttypefindelement.c
index 0f6b06f41874a40d852ae4786b3fed8acad65e17..b7af318535a0912d0ffb62ae0b4eda73ed3095a7 100644 (file)
--- a/plugins/elements/gsttypefindelement.c
+++ b/plugins/elements/gsttypefindelement.c
@@ -18,6 +18,15 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:element-typefind
+ *
+ * Determines the media-type of a stream. It applies typefind functions in the
+ * order of their rank. One the type has been deteted it sets its src pad caps
+ * to the found media type.
+ *
+ * Plugins can register custom typefinders by using #GstTypeFindFactory.
+ */
 
 /* FIXME: need a better solution for non-seekable streams */