From 27cd61d3c1505191df34155896e01f1cec165fc1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 5 Aug 2005 13:42:10 +0000 Subject: [PATCH] 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 --- check/gst-libs/.gitignore | 1 + docs/gst/gstreamer-sections.txt | 6 +- docs/gst/tmpl/.gitignore | 10 ++++ docs/gst/tmpl/gstfakesink.sgml | 64 -------------------- docs/gst/tmpl/gstfakesrc.sgml | 129 ---------------------------------------- docs/gst/tmpl/gstfilesink.sgml | 30 ---------- docs/gst/tmpl/gstfilesrc.sgml | 45 -------------- gst/elements/gstfakesink.c | 8 ++- gst/elements/gstfakesrc.c | 8 ++- gst/elements/gstfilesink.c | 8 ++- gst/elements/gstfilesrc.c | 8 +++ plugins/elements/gstfakesink.c | 8 ++- plugins/elements/gstfakesrc.c | 8 ++- plugins/elements/gstfilesink.c | 8 ++- plugins/elements/gstfilesrc.c | 8 +++ tests/check/libs/.gitignore | 1 + 16 files changed, 74 insertions(+), 276 deletions(-) delete mode 100644 docs/gst/tmpl/gstfakesink.sgml delete mode 100644 docs/gst/tmpl/gstfakesrc.sgml delete mode 100644 docs/gst/tmpl/gstfilesink.sgml delete mode 100644 docs/gst/tmpl/gstfilesrc.sgml diff --git a/check/gst-libs/.gitignore b/check/gst-libs/.gitignore index 0c7cfe3..0b88a81 100644 --- 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 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -1779,6 +1779,7 @@ gst_push_src_get_type
gstfakesrc GstFakeSrc +gst/elements/gstfakesrc.h GstFakeSrc GstFakeSrcClass @@ -1794,8 +1795,8 @@ gst_fake_src_get_type
gstfakesink GstFakeSink +gst/elements/gstfakesink.h GstFakeSink - GstFakeSinkClass GST_FAKESINK @@ -1810,6 +1811,7 @@ gst_fake_sink_get_type
gstfilesrc GstFileSrc +gst/elements/gstfilesrc.h GstFileSrc GstFileSrcClass @@ -1825,8 +1827,8 @@ gst_file_src_get_type
gstfilesink GstFileSink +gst/elements/gstfilesink.h GstFileSink - GstFileSinkClass GST_FILE_SINK diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore index a0788fb..b22ac3d 100644 --- 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 index bbf1d94..0000000 --- a/docs/gst/tmpl/gstfakesink.sgml +++ /dev/null @@ -1,64 +0,0 @@ - -GstFakeSink - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@gstfakesink: the object which received the signal. -@arg1: -@arg2: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfakesrc.sgml b/docs/gst/tmpl/gstfakesrc.sgml deleted file mode 100644 index a373829..0000000 --- a/docs/gst/tmpl/gstfakesrc.sgml +++ /dev/null @@ -1,129 +0,0 @@ - -GstFakeSrc - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@gstfakesrc: the object which received the signal. -@arg1: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: -@: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfilesink.sgml b/docs/gst/tmpl/gstfilesink.sgml deleted file mode 100644 index 9ec2717..0000000 --- a/docs/gst/tmpl/gstfilesink.sgml +++ /dev/null @@ -1,30 +0,0 @@ - -GstFileSink - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstfilesrc.sgml b/docs/gst/tmpl/gstfilesrc.sgml deleted file mode 100644 index 806b545..0000000 --- a/docs/gst/tmpl/gstfilesrc.sgml +++ /dev/null @@ -1,45 +0,0 @@ - -GstFileSrc - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/gst/elements/gstfakesink.c b/gst/elements/gstfakesink.c index c2c5c2a..a848e95 100644 --- 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 --- 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 #include diff --git a/gst/elements/gstfilesink.c b/gst/elements/gstfilesink.c index 8fbaf2a..570ce35 100644 --- 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 --- 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 --- 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 --- 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 #include diff --git a/plugins/elements/gstfilesink.c b/plugins/elements/gstfilesink.c index 8fbaf2a..570ce35 100644 --- 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 --- 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 --- a/tests/check/libs/.gitignore +++ b/tests/check/libs/.gitignore @@ -1,2 +1,3 @@ .dirstamp gdp +controller -- 2.7.4