Commit graph

5 commits

Author SHA1 Message Date
Wim Taymans
e990c2c7d5 Updated docs
Original commit message from CVS:
Updated docs
2000-11-07 21:18:52 +00:00
Wim Taymans
894215eb29 Documentation updates documented the libraries
Original commit message from CVS:
Documentation updates
documented the libraries
2000-10-22 16:27:21 +00:00
Wim Taymans
56e7d38238 Bring the low level API docs up to date.
Original commit message from CVS:
Bring the low level API docs up to date.
2000-09-13 19:04:55 +00:00
Wim Taymans
bf8c785fb0 Documentation updates. All standard library objects and standard elements are documented. Modified some of the elemen...
Original commit message from CVS:
Documentation updates. All standard library objects and standard
elements are documented. Modified some of the elements to more
accuratly report about their arguments so the documentation builds
more reasonable output.
Added aviencoder and jpegencoder elements (not working yet)
2000-03-27 19:53:43 +00:00
Erik Walthinsen
56a79fbfcc 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