Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now...
authorErik Walthinsen <omega@temple-baptist.org>
Tue, 1 Feb 2000 09:16:43 +0000 (09:16 +0000)
committerErik Walthinsen <omega@temple-baptist.org>
Tue, 1 Feb 2000 09:16:43 +0000 (09:16 +0000)
commit56a79fbfcc7834c2b3cba82c725654f49659c388
tree98074b5c34112da9565e72492d45bc477437a768
parentdc38347ceeb9f66b28713d889ccd9baa7a5ccca7
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.
32 files changed:
configure.in
docs/Makefile.am
docs/gst/.gitignore [new file with mode: 0644]
docs/gst/Makefile.am [new file with mode: 0644]
docs/gst/gstreamer-decl.txt [new file with mode: 0644]
docs/gst/gstreamer-docs.sgml [new file with mode: 0644]
docs/gst/gstreamer-sections.txt [new file with mode: 0644]
docs/gst/gstreamer.hierarchy [new file with mode: 0644]
docs/gst/gstreamer.types [new file with mode: 0644]
docs/gst/tmpl/.gitignore [new file with mode: 0644]
docs/gst/tmpl/gst.sgml [new file with mode: 0644]
docs/gst/tmpl/gstbin.sgml [new file with mode: 0644]
docs/gst/tmpl/gstbuffer.sgml [new file with mode: 0644]
docs/gst/tmpl/gstconnection.sgml [new file with mode: 0644]
docs/gst/tmpl/gstdisksrc.sgml [new file with mode: 0644]
docs/gst/tmpl/gstelement.sgml [new file with mode: 0644]
docs/gst/tmpl/gstfilter.sgml [new file with mode: 0644]
docs/gst/tmpl/gstmeta.sgml [new file with mode: 0644]
docs/gst/tmpl/gstobject.sgml [new file with mode: 0644]
docs/gst/tmpl/gstpad.sgml [new file with mode: 0644]
docs/gst/tmpl/gstpipeline.sgml [new file with mode: 0644]
docs/gst/tmpl/gstplugin.sgml [new file with mode: 0644]
docs/gst/tmpl/gstqueue.sgml [new file with mode: 0644]
docs/gst/tmpl/gstsink.sgml [new file with mode: 0644]
docs/gst/tmpl/gstsrc.sgml [new file with mode: 0644]
docs/gst/tmpl/gsttee.sgml [new file with mode: 0644]
docs/gst/tmpl/gstthread.sgml [new file with mode: 0644]
docs/gst/tmpl/gsttrace.sgml [new file with mode: 0644]
docs/gst/tmpl/gsttype.sgml [new file with mode: 0644]
docs/gst/tmpl/gstutils.sgml [new file with mode: 0644]
docs/gst/tmpl/gstxml.sgml [new file with mode: 0644]
docs/gst/tmpl/plugin.sgml [new file with mode: 0644]