From ef70805d2446d610d2903104cfe46228b567730f Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 20 Jun 2008 10:14:54 +0000 Subject: [PATCH] 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. --- ChangeLog | 17 ++++++++++++++ plugins/elements/gstcapsfilter.c | 1 - plugins/elements/gstfakesink.c | 1 - plugins/elements/gstfakesrc.c | 21 ++++++------------ plugins/elements/gstfdsink.c | 1 - plugins/elements/gstfdsrc.c | 32 +++++++++++---------------- plugins/elements/gstfilesink.c | 1 - plugins/elements/gstfilesrc.c | 1 - plugins/elements/gstidentity.c | 1 - plugins/elements/gstmultiqueue.c | 1 - plugins/elements/gstqueue.c | 1 - plugins/elements/gsttee.c | 1 - plugins/elements/gsttypefindelement.c | 9 ++++++++ 13 files changed, 46 insertions(+), 42 deletions(-) diff --git a/ChangeLog b/ChangeLog index cb086abbfc..3227f09aeb 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,20 @@ +2008-06-20 Stefan Kost + + * 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 * plugins/elements/gstfdsrc.c: (gst_fd_src_class_init): diff --git a/plugins/elements/gstcapsfilter.c b/plugins/elements/gstcapsfilter.c index edb17e70a7..bae446122b 100644 --- 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 47e60e8353..ba8402ae87 100644 --- 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 4d5d24f4f4..3dd9499596 100644 --- 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 * - * - * * The fakesrc element is a multipurpose element that can generate * a wide range of buffers and can operate in various scheduling modes. - * - * + * * It is mostly used as a testing element, one trivial example for testing * basic GStreamer core functionality is: - * + * + * * Example launch line - * - * + * |[ * gst-launch -v fakesrc num-buffers=5 ! fakesink - * - * 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. - * - * - * Last reviewed on 2005-12-02 (0.9.7) - * * + * + * 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 14b723b968..b11198fa95 100644 --- 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 b8626a4dc0..4f6beb3c39 100644 --- 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 * - * - * * Read data from a unix file descriptor. - * - * Examples - * - * Here is a simple pipeline to read from the standard input and dump the data - * with a fakesink. - * - * gst-launch -v fdsrc ! fakesink dump=1 - * + * * To generate data, enter some data on the console folowed by enter. * The above mentioned pipeline should dump data packets to the console. - * - * - * If the timeout property 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 * "GstFdSrcTimeout" * if no data was recieved in the given timeout. * The message's structure contains one field: @@ -54,11 +43,16 @@ * * * - * - * - * Last reviewed on 2008-06-20 (0.10.21) - * + * + * + * Example launch line + * |[ + * 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. * + * + * 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 7116568552..f17ba048de 100644 --- 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 e9d60fd15e..a01e610110 100644 --- 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 096f944e39..5d62d821cb 100644 --- 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 78bba70d8a..a787e06c40 100644 --- 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 * * diff --git a/plugins/elements/gstqueue.c b/plugins/elements/gstqueue.c index 9a9d711f9f..731a2ac1d7 100644 --- 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 f886b4b193..24cc4102e5 100644 --- 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 0f6b06f418..b7af318535 100644 --- 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 */