migrated some more docs to be inlined in the sources

Original commit message from CVS:
migrated some more docs to be inlined in the sources

diff --git a/check/gst-libs/.gitignore b/check/gst-libs/.gitignore
index 0c7cfe3..0b88a81 100644 (file)
--- a/check/gst-libs/.gitignore
+++ b/check/gst-libs/.gitignore
@@ -1,2 +1,3 @@
 .dirstamp
 gdp
+controller

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 812d69d..9ea0dff 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1779,6 +1779,7 @@ gst_push_src_get_type
 <SECTION>
 <FILE>gstfakesrc</FILE>
 <TITLE>GstFakeSrc</TITLE>
+<INCLUDE>gst/elements/gstfakesrc.h</INCLUDE>
 GstFakeSrc
 <SUBSECTION Standard>
 GstFakeSrcClass
@@ -1794,8 +1795,8 @@ gst_fake_src_get_type
 <SECTION>
 <FILE>gstfakesink</FILE>
 <TITLE>GstFakeSink</TITLE>
+<INCLUDE>gst/elements/gstfakesink.h</INCLUDE>
 GstFakeSink
-
 <SUBSECTION Standard>
 GstFakeSinkClass
 GST_FAKESINK
@@ -1810,6 +1811,7 @@ gst_fake_sink_get_type
 <SECTION>
 <FILE>gstfilesrc</FILE>
 <TITLE>GstFileSrc</TITLE>
+<INCLUDE>gst/elements/gstfilesrc.h</INCLUDE>
 GstFileSrc
 <SUBSECTION Standard>
 GstFileSrcClass
@@ -1825,8 +1827,8 @@ gst_file_src_get_type
 <SECTION>
 <FILE>gstfilesink</FILE>
 <TITLE>GstFileSink</TITLE>
+<INCLUDE>gst/elements/gstfilesink.h</INCLUDE>
 GstFileSink
-
 <SUBSECTION Standard>
 GstFileSinkClass
 GST_FILE_SINK

diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore
index a0788fb..b22ac3d 100644 (file)
--- a/docs/gst/tmpl/.gitignore
+++ b/docs/gst/tmpl/.gitignore
@@ -1,2 +1,12 @@
 *.bak
 unused-build.stamp
+gstadapter.sgml
+gstbasesink.sgml
+gstbasesrc.sgml
+gstbasetransform.sgml
+gstcollectpads.sgml
+gstfakesrc.sgml
+gstfakesink.sgml
+gstfilesrc.sgml
+gstfilesink.sgml
+gstpushsrc.sgml

diff --git a/docs/gst/tmpl/gstfakesink.sgml b/docs/gst/tmpl/gstfakesink.sgml
deleted file mode 100644 (file)
index bbf1d94..0000000
--- a/docs/gst/tmpl/gstfakesink.sgml
+++ /dev/null
@@ -1,64 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstFakeSink
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstFakeSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
-<para>
-
-</para>
-
-@gstfakesink: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### ARG GstFakeSink:dump ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSink:last-message ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSink:signal-handoffs ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSink:silent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSink:state-error ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSink:sync ##### -->
-<para>
-
-</para>
-

diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml
deleted file mode 100644 (file)
index a373829..0000000
--- a/docs/gst/tmpl/gstfakesrc.sgml
+++ /dev/null
@@ -1,129 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstFakeSrc
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstFakeSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
-<para>
-
-</para>
-
-@gstfakesrc: the object which received the signal.
-@arg1: 
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@: 
-
-<!-- ##### ARG GstFakeSrc:data ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:datarate ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:dump ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:filltype ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:has-getrange ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:has-loop ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:is-live ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:last-message ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:parentsize ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:pattern ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:signal-handoffs ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:silent ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:sizemax ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:sizemin ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:sizetype ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFakeSrc:sync ##### -->
-<para>
-
-</para>
-

diff --git a/docs/gst/tmpl/gstfilesink.sgml b/docs/gst/tmpl/gstfilesink.sgml
deleted file mode 100644 (file)
index 9ec2717..0000000
--- a/docs/gst/tmpl/gstfilesink.sgml
+++ /dev/null
@@ -1,30 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstFileSink
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstFileSink ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFileSink:location ##### -->
-<para>
-
-</para>
-

diff --git a/docs/gst/tmpl/gstfilesrc.sgml b/docs/gst/tmpl/gstfilesrc.sgml
deleted file mode 100644 (file)
index 806b545..0000000
--- a/docs/gst/tmpl/gstfilesrc.sgml
+++ /dev/null
@@ -1,45 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GstFileSrc
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GstFileSrc ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GstFileSrc:fd ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFileSrc:location ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFileSrc:mmapsize ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GstFileSrc:touch ##### -->
-<para>
-
-</para>
-

diff --git a/gst/elements/gstfakesink.c b/gst/elements/gstfakesink.c
index c2c5c2a..a848e95 100644 (file)
--- a/gst/elements/gstfakesink.c
+++ b/gst/elements/gstfakesink.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfakesink
+ * @short_description: black hole for data
+ * @see_also: #GstFakeSrc
+ *
+ * Dummy sink that swallows everything.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/gst/elements/gstfakesrc.c b/gst/elements/gstfakesrc.c
index 2894dbf..d5ad962 100644 (file)
--- a/gst/elements/gstfakesrc.c
+++ b/gst/elements/gstfakesrc.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfakesrc
+ * @short_description: Push empty (no data) buffers around
+ * @see_also: #GstFakeSink
+ *
+ * Dummy source that generates empty buffers.
+ */
 
 #include <stdlib.h>
 #include <string.h>

diff --git a/gst/elements/gstfilesink.c b/gst/elements/gstfilesink.c
index 8fbaf2a..570ce35 100644 (file)
--- a/gst/elements/gstfilesink.c
+++ b/gst/elements/gstfilesink.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfilesink
+ * @short_description: write stream to a file
+ * @see_also: #GstFileSrc
+ *
+ * Wrtite incomming data to a file in the local file system.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/gst/elements/gstfilesrc.c b/gst/elements/gstfilesrc.c
index a5de170..406fb1e 100644 (file)
--- a/gst/elements/gstfilesrc.c
+++ b/gst/elements/gstfilesrc.c
@@ -19,6 +19,14 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:gstfilesrc
+ * @short_description: read from arbitrary point in a file
+ * @see_also: #GstFileSrc
+ *
+ * Read data from a file in the local file system. The implementation is using
+ * mmap(2) to read chunks from the file in an efficient way.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/elements/gstfakesink.c b/plugins/elements/gstfakesink.c
index c2c5c2a..a848e95 100644 (file)
--- a/plugins/elements/gstfakesink.c
+++ b/plugins/elements/gstfakesink.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfakesink
+ * @short_description: black hole for data
+ * @see_also: #GstFakeSrc
+ *
+ * Dummy sink that swallows everything.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/elements/gstfakesrc.c b/plugins/elements/gstfakesrc.c
index 2894dbf..d5ad962 100644 (file)
--- a/plugins/elements/gstfakesrc.c
+++ b/plugins/elements/gstfakesrc.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfakesrc
+ * @short_description: Push empty (no data) buffers around
+ * @see_also: #GstFakeSink
+ *
+ * Dummy source that generates empty buffers.
+ */
 
 #include <stdlib.h>
 #include <string.h>

diff --git a/plugins/elements/gstfilesink.c b/plugins/elements/gstfilesink.c
index 8fbaf2a..570ce35 100644 (file)
--- a/plugins/elements/gstfilesink.c
+++ b/plugins/elements/gstfilesink.c
@@ -19,7 +19,13 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstfilesink
+ * @short_description: write stream to a file
+ * @see_also: #GstFileSrc
+ *
+ * Wrtite incomming data to a file in the local file system.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/plugins/elements/gstfilesrc.c b/plugins/elements/gstfilesrc.c
index a5de170..406fb1e 100644 (file)
--- a/plugins/elements/gstfilesrc.c
+++ b/plugins/elements/gstfilesrc.c
@@ -19,6 +19,14 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+/**
+ * SECTION:gstfilesrc
+ * @short_description: read from arbitrary point in a file
+ * @see_also: #GstFileSrc
+ *
+ * Read data from a file in the local file system. The implementation is using
+ * mmap(2) to read chunks from the file in an efficient way.
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include "config.h"

diff --git a/tests/check/libs/.gitignore b/tests/check/libs/.gitignore
index 0c7cfe3..0b88a81 100644 (file)
--- a/tests/check/libs/.gitignore
+++ b/tests/check/libs/.gitignore
@@ -1,2 +1,3 @@
 .dirstamp
 gdp
+controller