Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
|
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
|
|
|
|
|
<!entity Gst SYSTEM "sgml/gst.sgml">
|
2000-12-30 16:13:17 +00:00
|
|
|
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
|
|
|
|
|
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
|
2000-10-22 16:27:21 +00:00
|
|
|
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
|
2000-09-13 19:04:55 +00:00
|
|
|
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
|
|
|
|
|
<!entity GstMeta SYSTEM "sgml/gstmeta.sgml">
|
|
|
|
|
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
|
|
|
|
|
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
|
2000-12-28 21:42:23 +00:00
|
|
|
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
|
2001-01-21 23:20:46 +00:00
|
|
|
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
|
|
|
|
|
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
|
|
|
|
|
<!entity GstType SYSTEM "sgml/gsttype.sgml">
|
2000-12-28 21:42:23 +00:00
|
|
|
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
|
|
|
|
|
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
|
2001-01-31 20:27:00 +00:00
|
|
|
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
|
2001-01-19 22:15:21 +00:00
|
|
|
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
|
|
|
|
|
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
|
2000-11-07 21:18:52 +00:00
|
|
|
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
|
2001-03-21 21:43:56 +00:00
|
|
|
<!entity GstStaticAutoplug SYSTEM "sgml/gststaticautoplug.sgml">
|
|
|
|
|
<!entity GstStaticAutoplugRender SYSTEM "sgml/gststaticautoplugrender.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
|
|
|
|
|
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
|
|
|
|
|
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
|
|
|
|
|
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
|
|
|
|
|
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
|
|
|
|
|
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
|
|
|
|
|
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
|
|
|
|
|
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
|
2000-09-13 19:04:55 +00:00
|
|
|
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
|
2001-01-19 22:15:21 +00:00
|
|
|
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
|
2000-03-27 19:53:43 +00:00
|
|
|
|
|
|
|
|
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
|
|
|
|
|
<!entity videoraw SYSTEM "sgml/videoraw.sgml">
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
|
|
|
|
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
|
|
|
|
|
]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<book>
|
|
|
|
|
<bookinfo>
|
2000-10-22 16:27:21 +00:00
|
|
|
<title>GStreamer Library Reference Manual (Core)</title>
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</bookinfo>
|
|
|
|
|
<chapter id="gstreamer">
|
|
|
|
|
<title>GStreamer Core Library</title>
|
|
|
|
|
|
|
|
|
|
<para>libgst.la provides all the core GStreamer services,
|
|
|
|
|
including initialization, plugin management, types and metadata, as
|
|
|
|
|
well as the object hiarchy that defines elements and bins, along
|
|
|
|
|
with some more specialized elements.</para>
|
|
|
|
|
|
|
|
|
|
&Gst;
|
2000-12-28 21:42:23 +00:00
|
|
|
&GstAutoplug;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstBin;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstBuffer;
|
2000-10-22 16:27:21 +00:00
|
|
|
&GstBufferPool;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstCaps;
|
|
|
|
|
&GstCpu;
|
|
|
|
|
&GstElement;
|
|
|
|
|
&GstInfo;
|
|
|
|
|
&GstMeta;
|
|
|
|
|
&GstObject;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstPad;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstParse;
|
|
|
|
|
&GstPipeline;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
&GstPlugin;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstProps;
|
2001-01-19 22:15:21 +00:00
|
|
|
&GstQueue;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstThread;
|
|
|
|
|
&GstTrace;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstType;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstTypeFind;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstUtils;
|
2001-01-31 20:27:00 +00:00
|
|
|
&GstXML;
|
2000-11-07 21:18:52 +00:00
|
|
|
|
|
|
|
|
&cothreads;
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="element-types">
|
2000-03-27 19:53:43 +00:00
|
|
|
<title>GStreamer Standard Elements</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
libgstelements.la provide some basic elements like a disk source
|
|
|
|
|
and sink. The use of these elements is strictly though the gtk_object_get() and
|
|
|
|
|
gtk_object_set() functions and the GStreamer Core Library functions.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
Use the gst_elementfactory_find() and gst_elementfactory_create() functions
|
|
|
|
|
to create these elements.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
The following code example shows you how to create a GstDiskSrc element.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
<programlisting role="C">
|
|
|
|
|
#include <gst/gst.h>
|
|
|
|
|
|
|
|
|
|
GstElement *src;
|
|
|
|
|
GstElementFactory *srcfactory;
|
|
|
|
|
|
|
|
|
|
gst_init(&argc,&argv);
|
|
|
|
|
|
|
|
|
|
srcfactory = gst_elementfactory_find("disksrc");
|
|
|
|
|
g_return_if_fail(srcfactory != NULL);
|
|
|
|
|
src = gst_elementfactory_create(srcfactory,"src");
|
|
|
|
|
g_return_if_fail(src != NULL);
|
|
|
|
|
...
|
|
|
|
|
</programlisting>
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
&GstFakeSrc;
|
|
|
|
|
&GstFakeSink;
|
|
|
|
|
|
|
|
|
|
&GstDiskSrc;
|
|
|
|
|
&GstHttpSrc;
|
2000-10-22 16:27:21 +00:00
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstSineSrc;
|
|
|
|
|
|
2000-10-22 16:27:21 +00:00
|
|
|
&GstFdSrc;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstFdSink;
|
|
|
|
|
|
2000-09-13 19:04:55 +00:00
|
|
|
&GstPipefilter;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstIdentity;
|
2000-10-22 16:27:21 +00:00
|
|
|
|
2001-01-19 22:15:21 +00:00
|
|
|
&GstTee;
|
2000-03-27 19:53:43 +00:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter id="metatdata-types">
|
|
|
|
|
<title>GStreamer MetaData Types</title>
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
<para>MetaData is used to specify the content of buffers. See <classname>GstMeta</classname>. </para>
|
|
|
|
|
|
|
|
|
|
&spectrum;
|
|
|
|
|
&videoraw;
|
|
|
|
|
</chapter>
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2001-03-21 21:43:56 +00:00
|
|
|
<chapter id="autopluggers">
|
|
|
|
|
<title>GStreamer Autoppluggers</title>
|
|
|
|
|
|
|
|
|
|
<para>the autopluggers provide a way to automatically construct elements based on
|
|
|
|
|
sink and src capabilities</para>
|
|
|
|
|
|
|
|
|
|
&GstStaticAutoplug;
|
|
|
|
|
&GstStaticAutoplugRender;
|
|
|
|
|
</chapter>
|
|
|
|
|
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
<chapter id="gst-index">
|
|
|
|
|
<title>Index</title>
|
|
|
|
|
|
|
|
|
|
<sect1>
|
|
|
|
|
<title>Object Hierarchy</title>
|
|
|
|
|
&gstreamer-tree-index;
|
|
|
|
|
</sect1>
|
|
|
|
|
</chapter>
|
|
|
|
|
</book>
|
