add all plugin docs to the documentation

Original commit message from CVS:
add all plugin docs to the documentation
This commit is contained in:
Thomas Vander Stichele 2005-08-15 14:52:08 +00:00
parent 906b53b7dd
commit e60ded44d7
5 changed files with 99 additions and 5 deletions

View file

@ -69,9 +69,21 @@ SCANOBJ_DEPS =
IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h dsputil.h IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h dsputil.h
IGNORE_CFILES = utils.c mem.c imgconvert.c IGNORE_CFILES = utils.c mem.c imgconvert.c
# we add all .h files of elements that have signals/args we want
# sadly this also pulls in the private methods - maybe we should
# move those around in the source ?
# also, we should add some stuff here conditionally based on whether
# or not the plugin will actually build
# but I'm not sure about that - it might be this Just Works given that
# the registry won't have the element
# FIXME: not ported yet
# $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
EXTRA_HFILES = \ EXTRA_HFILES = \
$(top_srcdir)/gst/tcp/gstmultifdsink.h \ $(top_srcdir)/gst/tcp/gstmultifdsink.h \
$(top_srcdir)/gst/tcp/gsttcpserversink.h $(top_srcdir)/gst/tcp/gsttcpserversink.h \
$(top_srcdir)/ext/vorbis/vorbisenc.h
# Images to copy into HTML directory. # Images to copy into HTML directory.
HTML_IMAGES = HTML_IMAGES =

View file

@ -10,9 +10,39 @@
<title>GStreamer Base Plugins &GST_MAJORMINOR; Plugins Reference Manual</title> <title>GStreamer Base Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
</bookinfo> </bookinfo>
<chapter>
<title>gst-plugins-base Elements</title>
<xi:include href="xml/element-multifdsink.xml" />
<xi:include href="xml/element-tcpserversink.xml" />
<!--
<xi:include href="xml/element-gnomevfssink.xml" />
-->
<xi:include href="xml/element-vorbisenc.xml" />
</chapter>
<chapter> <chapter>
<title>gst-plugins-base Plugins</title> <title>gst-plugins-base Plugins</title>
<xi:include href="xml/multifdsink.xml"/> <xi:include href="xml/plugin-adder.xml" />
<xi:include href="xml/tcpserversink.xml"/> <xi:include href="xml/plugin-alsa.xml" />
<xi:include href="xml/plugin-audioconvert.xml" />
<xi:include href="xml/plugin-audiorate.xml" />
<xi:include href="xml/plugin-decodebin.xml" />
<xi:include href="xml/plugin-gnomevfs.xml" />
<xi:include href="xml/plugin-ogg.xml" />
<xi:include href="xml/plugin-playbin.xml" />
<xi:include href="xml/plugin-sine.xml" />
<xi:include href="xml/plugin-subparse.xml" />
<xi:include href="xml/plugin-tcp.xml" />
<xi:include href="xml/plugin-theora.xml" />
<xi:include href="xml/plugin-typefindfunctions.xml" />
<xi:include href="xml/plugin-video4linux.xml" />
<xi:include href="xml/plugin-videorate.xml" />
<xi:include href="xml/plugin-videoscale.xml" />
<xi:include href="xml/plugin-videotestsrc.xml" />
<xi:include href="xml/plugin-volume.xml" />
<xi:include href="xml/plugin-vorbis.xml" />
<xi:include href="xml/plugin-ximage.xml" />
<xi:include href="xml/plugin-xvimagesink.xml" />
</chapter> </chapter>
</book> </book>

View file

@ -1,5 +1,5 @@
<SECTION> <SECTION>
<FILE>multifdsink</FILE> <FILE>element-multifdsink</FILE>
GstMultiFdSink GstMultiFdSink
GstMultiFdSinkFlags GstMultiFdSinkFlags
GstRecoverPolicy GstRecoverPolicy
@ -12,16 +12,42 @@ GstMultiFdSinkClass
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>tcpserversink</FILE> <FILE>element-tcpserversink</FILE>
GstTCPServerSink GstTCPServerSink
<TITLE>tcpserversink</TITLE> <TITLE>tcpserversink</TITLE>
<SUBSECTION Standard> <SUBSECTION Standard>
GstTCPServerSinkClass GstTCPServerSinkClass
</SECTION> </SECTION>
<SECTION>
<FILE>element-tcpserversink</FILE>
GstTCPServerSink
<TITLE>tcpserversink</TITLE>
<SUBSECTION Standard>
GstTCPServerSinkClass
</SECTION>
<SECTION>
<FILE>element-gnomevfssink</FILE>
GstGnomeVFSSink
<TITLE>gnomevfssink</TITLE>
<SUBSECTION Standard>
GstGnomeVFSSinkClass
</SECTION>
<SECTION>
<FILE>element-vorbisenc</FILE>
<TITLE>vorbisenc</TITLE>
GstVorbisEnc
<SUBSECTION Standard>
GstVorbisEncClass
</SECTION>
<SECTION> <SECTION>
<FILE>private</FILE> <FILE>private</FILE>
CLIENTS_UNLOCK CLIENTS_UNLOCK
CLIENTS_LOCK_INIT CLIENTS_LOCK_INIT
GST_MULTIFDSINK_GET_CLASS GST_MULTIFDSINK_GET_CLASS
@ -38,4 +64,29 @@ GST_MULTIFDSINK_CLASS
gst_multifdsink_get_stats gst_multifdsink_get_stats
GST_MULTIFDSINK GST_MULTIFDSINK
gst_multifdsink_add gst_multifdsink_add
GST_TCPSERVERSINK
GstTCPServerSinkFlags
GST_TYPE_TCPSERVERSINK
gst_tcpserversink_get_type
GST_IS_TCPSERVERSINK_CLASS
GST_IS_TCPSERVERSINK
GST_GNOMEVFSSINK_CLASS
GST_TYPE_GNOMEVFSSINK
GST_IS_GNOMEVFSSINK
gst_gnomevfssink_get_type
GST_IS_GNOMEVFSSINK_CLASS
GST_ELEMENT_CLASS
GstGnomeVFSSinkFlags
GST_GNOMEVFSSINK
GST_IS_VORBISENC
GST_VORBISENC_CLASS
GST_VORBISENC
GST_TCPSERVERSINK_CLASS
GST_TYPE_VORBISENC
GST_IS_VORBISENC_CLASS
vorbisenc_get_type
</SECTION> </SECTION>

View file

View file

@ -0,0 +1 @@
timestamp