Commit 9bae9d4b authored by Wim Taymans's avatar Wim Taymans
Browse files

More Docs updates.

Original commit message from CVS:
More Docs updates.
Added plugin documentation. I fear we need a gstdoc implementation
that loads plugins and does introspection on them. I think we should
automatically create the docs for the pads and mime types the plugins
provide. Does anyone have enough perl knowledge to add these features? I
allready changed the C code to output the pad definitions but my perl
knowledge is too limited, for now, to implement the rest of the needed
functionality...
parent 268bcbb8
......@@ -476,6 +476,9 @@ tools/Makefile
docs/Makefile
docs/gst/Makefile
docs/gst/gstreamer.types
docs/libs/Makefile
docs/plugins/Makefile
docs/plugins/gstreamer-plugins.types
docs/manual/Makefile
docs/manual/images/Makefile
stamp.h
......
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=gstreamer-plugins
# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/plugins
INCLUDES = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir)
LDADD = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la
CFLAGS = `gstreamer-config --cflags` -Wall -g
LDFLAGS = `gstreamer-config --libs`
EXTRA_DIST=$(DOC_MODULE).types.in
HTML_DIR=$(datadir)/$(DOC_MODULE)/html
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
tmpl_sources = \
tmpl/videoraw.sgml
gstreamer_docdir = $(HTML_DIR)
gstreamer_doc_DATA = \
$(DOC_MODULE).html \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).types \
$(DOC_MODULE)-sections.txt
SCANOBJS_FILES = \
$(DOC_MODULE).signals \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).args
if HAVE_GTK_DOC
$(DOC_MODULE).html: html/book1.html
-cd $(srcdir) && cp html/book1.html $(DOC_MODULE).html
else
$(DOC_MODULE).html:
endif
html/book1.html: sgml/$(DOC_MODULE)-doc.bottom
$(MAKE) html
sgml/$(DOC_MODULE)-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
scanobj:
CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" ./gstdoc-scanobj --module=$(DOC_MODULE)
tmpl: scanobj
./gstdoc-mktmpl --module=$(DOC_MODULE)
sgml: tmpl
./gstdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
if ! test -d html ; then mkdir html ; fi
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *.signals *-unused.txt *.args
maintainer-clean-local: clean
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
.PHONY : html sgml templates
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity GstParseAu SYSTEM "sgml/gstparseau.sgml">
<!entity Audioscale SYSTEM "sgml/audioscale.sgml">
<!entity GstAviEncoder SYSTEM "sgml/gstaviencoder.sgml">
<!entity GstParseAvi SYSTEM "sgml/gstparseavi.sgml">
<!entity GstWinDec SYSTEM "sgml/gstwindec.sgml">
<!entity GstWinEnc SYSTEM "sgml/gstwinenc.sgml">
<!entity GstV4lSrc SYSTEM "sgml/gstv4lsrc.sgml">
<!entity GstStereo SYSTEM "sgml/stereo.sgml">
<!entity GstVolume SYSTEM "sgml/volume.sgml">
<!entity GstMedian SYSTEM "sgml/median.sgml">
<!entity GstSmooth SYSTEM "sgml/smooth.sgml">
<!entity GstJpegDec SYSTEM "sgml/gstjpegdec.sgml">
<!entity GstJpegEnc SYSTEM "sgml/gstjpegenc.sgml">
<!entity GstMpg123 SYSTEM "sgml/gstmpg123.sgml">
<!entity Mp3Parse SYSTEM "sgml/mp3parse.sgml">
<!entity GstMpegplay SYSTEM "sgml/gstmpeg_play.sgml">
<!entity GstMpegAudio SYSTEM "sgml/gstmpegaudio.sgml">
<!entity GstMpeg1Parse SYSTEM "sgml/mpeg1parse.sgml">
<!entity SystemEncode SYSTEM "sgml/system_encode.sgml">
<!entity Mp1VideoParse SYSTEM "sgml/mp1videoparse.sgml">
<!entity Ac3Dec SYSTEM "sgml/ac3dec.sgml">
<!entity Ac3Parse SYSTEM "sgml/ac3parse.sgml">
<!entity GstMpeg2enc SYSTEM "sgml/gstmpeg2enc.sgml">
<!entity Mpeg2Parse SYSTEM "sgml/mpeg2parse.sgml">
<!entity Mpeg2Subt SYSTEM "sgml/mpeg2subt.sgml">
<!entity Mpeg2Play SYSTEM "sgml/gstmpeg2play.sgml">
<!entity Mp2VideoParse SYSTEM "sgml/mp2videoparse.sgml">
<!entity RTJpegDec SYSTEM "sgml/rtjpegdec.sgml">
<!entity RTJpegEnc SYSTEM "sgml/rtjpegenc.sgml">
<!entity VCDSrc SYSTEM "sgml/vcdsrc.sgml">
<!entity Videoscale SYSTEM "sgml/videoscale.sgml">
<!entity VideoSink SYSTEM "sgml/videosink.sgml">
<!entity GstSmoothWave SYSTEM "sgml/smoothwave.sgml">
<!entity GstSpectrum SYSTEM "sgml/gstspectrum.sgml">
<!entity GstSynaesthesia SYSTEM "sgml/synaesthesia.sgml">
<!entity GstVuMeter SYSTEM "sgml/vumeter.sgml">
<!entity VorbisDec SYSTEM "sgml/vorbisdec.sgml">
<!entity VorbisEnc SYSTEM "sgml/vorbisenc.sgml">
<!entity GstParseWav SYSTEM "sgml/gstparsewav.sgml">
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
]>
<book>
<bookinfo>
<title>GStreamer Library Reference Manual (Plugins)</title>
</bookinfo>
<chapter id="plugins">
<title>GStreamer Standard Plugins</title>
<para>
The following code example shows you how to create a GstDiskSrc element.
</para>
&GstParseAu;
&Audioscale;
&GstAviEncoder;
&GstParseAvi;
&GstWinDec;
&GstWinEnc;
&GstParseWav;
&GstV4lSrc;
&GstStereo;
&GstVolume;
&GstMedian;
&GstSmooth;
&GstJpegDec;
&GstJpegEnc;
&GstMpg123;
&Mp3Parse;
&GstMpegplay;
&GstMpegAudio;
&GstMpeg1Parse;
&SystemEncode;
&Mp1VideoParse;
&Ac3Dec;
&Ac3Parse;
&GstMpeg2enc;
&Mpeg2Parse;
&Mpeg2Subt;
&Mpeg2Play;
&Mp2VideoParse;
&RTJpegDec;
&RTJpegEnc;
&VCDSrc;
&Videoscale;
&VideoSink;
&GstSmoothWave;
&GstSpectrum;
&GstSynaesthesia;
&GstVuMeter;
&VorbisDec;
&VorbisEnc;
</chapter>
<chapter id="gst-index">
<title>Index</title>
<sect1>
<title>Object Hierarchy</title>
&gstreamer-tree-index;
</sect1>
</chapter>
</book>
This diff is collapsed.
<!-- ##### SECTION Title ##### -->
Ac3Dec
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
Ac3Parse
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG Ac3Parse:skip ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
Audioscale
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG Audioscale:frequency ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstCoBin
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
DVDSrc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstExample
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstAviEncoder
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstAviEncoder:video ##### -->
<para>
</para>
<!-- ##### ARG GstAviEncoder:audio ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstJpeg
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstJpegDec
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstJpegEnc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstMpeg1encoder
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstMpeg2enc
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstMpeg2enc:frames_per_second ##### -->
<para>
</para>
<!-- ##### SECTION Title ##### -->
GstMpeg2play
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstMpeg2play:frames_per_second ##### -->
<para>
</para>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment