mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-05 15:08:53 +00:00
Code Issues 1 Projects Releases Wiki Activity

migrated some more docs to be inlined in the sources

Browse source 
Original commit message from CVS:
migrated some more docs to be inlined in the sources
This commit is contained in:
Stefan Kost 2005-08-05 13:42:10 +00:00
parent da7dd48860
commit 27cd61d3c1
16 changed files with 74 additions and 276 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
check/gst-libs/.gitignore vendored
View file

@ -1,2 +1,3 @@
.dirstamp .dirstamp
gdp gdp
controller

6
docs/gst/gstreamer-sections.txt
View file

@ -1779,6 +1779,7 @@ gst_push_src_get_type
<SECTION> <SECTION>
<FILE>gstfakesrc</FILE> <FILE>gstfakesrc</FILE>
<TITLE>GstFakeSrc</TITLE> <TITLE>GstFakeSrc</TITLE>
<INCLUDE>gst/elements/gstfakesrc.h</INCLUDE>
GstFakeSrc GstFakeSrc
<SUBSECTION Standard> <SUBSECTION Standard>
GstFakeSrcClass GstFakeSrcClass
@ -1794,8 +1795,8 @@ gst_fake_src_get_type
<SECTION> <SECTION>
<FILE>gstfakesink</FILE> <FILE>gstfakesink</FILE>
<TITLE>GstFakeSink</TITLE> <TITLE>GstFakeSink</TITLE>
<INCLUDE>gst/elements/gstfakesink.h</INCLUDE>
GstFakeSink GstFakeSink
<SUBSECTION Standard> <SUBSECTION Standard>
GstFakeSinkClass GstFakeSinkClass
GST_FAKESINK GST_FAKESINK
@ -1810,6 +1811,7 @@ gst_fake_sink_get_type
<SECTION> <SECTION>
<FILE>gstfilesrc</FILE> <FILE>gstfilesrc</FILE>
<TITLE>GstFileSrc</TITLE> <TITLE>GstFileSrc</TITLE>
<INCLUDE>gst/elements/gstfilesrc.h</INCLUDE>
GstFileSrc GstFileSrc
<SUBSECTION Standard> <SUBSECTION Standard>
GstFileSrcClass GstFileSrcClass
@ -1825,8 +1827,8 @@ gst_file_src_get_type
<SECTION> <SECTION>
<FILE>gstfilesink</FILE> <FILE>gstfilesink</FILE>
<TITLE>GstFileSink</TITLE> <TITLE>GstFileSink</TITLE>
<INCLUDE>gst/elements/gstfilesink.h</INCLUDE>
GstFileSink GstFileSink
<SUBSECTION Standard> <SUBSECTION Standard>
GstFileSinkClass GstFileSinkClass
GST_FILE_SINK GST_FILE_SINK

10
docs/gst/tmpl/.gitignore vendored
View file

@ -1,2 +1,12 @@
*.bak *.bak
unused-build.stamp unused-build.stamp
gstadapter.sgml
gstbasesink.sgml
gstbasesrc.sgml
gstbasetransform.sgml
gstcollectpads.sgml
gstfakesrc.sgml
gstfakesink.sgml
gstfilesrc.sgml
gstfilesink.sgml
gstpushsrc.sgml

64
docs/gst/tmpl/gstfakesink.sgml
View file

@ -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>

129
docs/gst/tmpl/gstfakesrc.sgml
View file

@ -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>

30
docs/gst/tmpl/gstfilesink.sgml
View file

@ -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>

45
docs/gst/tmpl/gstfilesrc.sgml
View file

@ -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>

8
gst/elements/gstfakesink.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

8
gst/elements/gstfakesrc.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 <stdlib.h>
#include <string.h> #include <string.h>

8
gst/elements/gstfilesink.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

8
gst/elements/gstfilesrc.c
View file

@ -19,6 +19,14 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

8
plugins/elements/gstfakesink.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

8
plugins/elements/gstfakesrc.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 <stdlib.h>
#include <string.h> #include <string.h>

8
plugins/elements/gstfilesink.c
View file

@ -19,7 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

8
plugins/elements/gstfilesrc.c
View file

@ -19,6 +19,14 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA. * 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 #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"

1
tests/check/libs/.gitignore vendored
View file

@ -1,2 +1,3 @@
.dirstamp .dirstamp
gdp gdp
controller