2003-05-18 15:04:26 +00:00
|
|
|
<?xml version="1.0"?>
|
|
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
2004-02-12 17:23:37 +00:00
|
|
|
<!ENTITY % version-entities SYSTEM "../version.entities">
|
|
|
|
|
%version-entities;
|
|
|
|
|
<!ENTITY Gst SYSTEM "xml/gst.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY Gst SYSTEM "xml/gst.xml">
|
|
|
|
|
<!ENTITY GstAtomic SYSTEM "xml/gstatomic.xml">
|
|
|
|
|
<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
|
|
|
|
|
<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
|
|
|
|
|
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
|
|
|
|
|
<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstCpu SYSTEM "xml/gstcpu.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstData SYSTEM "xml/gstdata.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
|
|
|
|
|
<!ENTITY GstError SYSTEM "xml/gsterror.xml">
|
|
|
|
|
<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstInterface SYSTEM "xml/gstinterface.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstLog SYSTEM "xml/gstlog.xml">
|
|
|
|
|
<!ENTITY GstMemChunk SYSTEM "xml/gstmemchunk.xml">
|
|
|
|
|
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
|
|
|
|
|
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
|
|
|
|
|
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
|
|
|
|
|
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
|
|
|
|
|
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
|
|
|
|
|
<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstProbe SYSTEM "xml/gstprobe.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
|
|
|
|
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
|
|
|
|
<!ENTITY GstRegistryPool SYSTEM "xml/gstregistrypool.xml">
|
|
|
|
|
<!ENTITY GstScheduler SYSTEM "xml/gstscheduler.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
|
|
|
|
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
|
|
|
|
|
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
|
|
|
|
|
<!ENTITY GstTagInterface SYSTEM "xml/gsttaginterface.xml">
|
|
|
|
|
<!ENTITY GstThread SYSTEM "xml/gstthread.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
|
2003-10-28 20:25:30 +00:00
|
|
|
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
|
|
|
|
|
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
|
|
|
|
|
<!ENTITY GstUri SYSTEM "xml/gsturi.xml">
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- not commented properly yet
|
|
|
|
|
<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
|
|
|
|
|
-->
|
2003-05-18 15:04:26 +00:00
|
|
|
<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
|
|
|
|
|
<!-- these are elements without API docs
|
|
|
|
|
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
|
|
|
|
-->
|
|
|
|
|
<!ENTITY cothreads SYSTEM "xml/cothreads.xml">
|
|
|
|
|
|
|
|
|
|
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
|
|
|
|
|
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
|
|
|
|
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
|
|
|
|
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
|
|
|
|
<!ENTITY GstDiskSink SYSTEM "xml/gstdisksink.xml">
|
|
|
|
|
<!ENTITY GstFdSrc SYSTEM "xml/gstfdsrc.xml">
|
|
|
|
|
<!ENTITY GstFdSink SYSTEM "xml/gstfdsink.xml">
|
|
|
|
|
<!ENTITY GstIdentity SYSTEM "xml/gstidentity.xml">
|
|
|
|
|
<!ENTITY GstPipefilter SYSTEM "xml/gstpipefilter.xml">
|
|
|
|
|
<!ENTITY GstStatistics SYSTEM "xml/gststatistics.xml">
|
|
|
|
|
<!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
|
|
|
|
|
<!ENTITY GstTee SYSTEM "xml/gsttee.xml">
|
|
|
|
|
|
|
|
|
|
<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.xml">
|
2003-06-29 14:05:49 +00:00
|
|
|
|
|
|
|
|
<!ENTITY hash "#">
|
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
|
|
|
]>
|
|
|
|
|
<book>
|
|
|
|
|
<bookinfo>
|
2004-02-12 17:23:37 +00:00
|
|
|
<title>GStreamer &GST_MAJORMINOR; Core API Reference (&GST_VERSION;)</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>
|
2002-12-14 16:22:01 +00:00
|
|
|
|
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="gstreamer">
|
|
|
|
|
<title>GStreamer Core Library</title>
|
|
|
|
|
|
|
|
|
|
<para>libgst.la provides all the core GStreamer services,
|
2001-07-07 10:55:58 +00:00
|
|
|
including initialization, plugin management and types, as
|
2002-04-17 12:28:32 +00:00
|
|
|
well as the object hierarchy that defines elements and bins, along
|
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
|
|
|
with some more specialized elements.</para>
|
|
|
|
|
|
|
|
|
|
&Gst;
|
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;
|
2003-06-29 14:05:49 +00:00
|
|
|
&GstConfig;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstCaps;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstClock;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstCpu;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstData;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstElement;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstElementFactory;
|
|
|
|
|
&GstError;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstEvent;
|
2002-12-14 13:02:16 +00:00
|
|
|
&GstFormat;
|
2003-01-02 18:56:09 +00:00
|
|
|
&GstIndex;
|
2001-01-21 23:20:46 +00:00
|
|
|
&GstInfo;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstInterface;
|
2001-01-21 23:20:46 +00:00
|
|
|
&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-10-19 22:49:35 +00:00
|
|
|
&GstPluginFeature;
|
2002-12-14 13:02:16 +00:00
|
|
|
&GstProbe;
|
2002-12-30 17:54:02 +00:00
|
|
|
&GstQuery;
|
2003-05-18 15:04:26 +00:00
|
|
|
<!-- no API docs
|
|
|
|
|
&GstQueue; -->
|
2002-06-12 22:27:18 +00:00
|
|
|
&GstRegistry;
|
2003-02-10 23:01:55 +00:00
|
|
|
&GstRegistryPool;
|
2001-05-27 14:33:30 +00:00
|
|
|
&GstScheduler;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstStructure;
|
2002-03-31 14:00:33 +00:00
|
|
|
&GstSystemClock;
|
2004-01-30 19:06:13 +00:00
|
|
|
&GstTag;
|
|
|
|
|
&GstTagInterface;
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstThread;
|
2003-10-28 20:25:30 +00:00
|
|
|
&GstTypeFind;
|
|
|
|
|
&GstTypeFindFactory;
|
2003-02-10 23:01:55 +00:00
|
|
|
&GstUri;
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstUtils;
|
2004-01-30 19:06:13 +00:00
|
|
|
<!-- not commented properly yet
|
|
|
|
|
&GstValue;
|
|
|
|
|
-->
|
2001-01-31 20:27:00 +00:00
|
|
|
&GstXML;
|
2000-11-07 21:18:52 +00:00
|
|
|
|
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>
|
|
|
|
|
|
2004-01-28 14:33:59 +00:00
|
|
|
<chapter id="gstreamer-support">
|
|
|
|
|
<title>GStreamer Core Support</title>
|
|
|
|
|
<para>
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
&cothreads;
|
|
|
|
|
&GstAtomic;
|
|
|
|
|
&GstMemChunk;
|
|
|
|
|
|
|
|
|
|
</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="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
|
2001-10-24 21:44:48 +00:00
|
|
|
and sink. The use of these elements is strictly though the g_object_get() and
|
|
|
|
|
g_object_set() functions and the GStreamer Core Library functions.
|
2000-03-27 19:53:43 +00:00
|
|
|
</para>
|
|
|
|
|
|
2001-10-19 22:49:35 +00:00
|
|
|
&GstAggregator;
|
|
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
&GstFakeSrc;
|
|
|
|
|
&GstFakeSink;
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
&GstFileSrc;
|
2001-04-22 16:04:19 +00:00
|
|
|
&GstDiskSink;
|
|
|
|
|
|
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-12-09 13:17:13 +00:00
|
|
|
&GstStatistics;
|
2002-03-31 14:00:33 +00:00
|
|
|
&GstMD5Sink;
|
2001-12-09 13:17:13 +00:00
|
|
|
|
2001-01-19 22:15:21 +00:00
|
|
|
&GstTee;
|
2000-03-27 19:53:43 +00:00
|
|
|
</chapter>
|
2004-01-28 14:33:59 +00:00
|
|
|
-->
|
2000-03-27 19:53:43 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
<!--
|
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>
|
2003-05-18 15:04:26 +00:00
|
|
|
-->
|
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
|
|
|
</book>
|
