[gst-devel] (no subject)

nicholasfrancis at iname.com nicholasfrancis at iname.com
Sun Mar 26 06:52:05 CEST 2000


Wim Taymans wrote:
> 
> Erik Walthinsen wrote:
> >
> > On Sat, 25 Mar 2000, Nicholas Francis wrote:
> >
> > > please,please,please move the documentation up on your list.
> >
> > It is, I just have to figure out what form to write it in first.  What
> > kind of documenation is most immediately useful to you?  A walkthrough
> > from top-down, API docs, etc?
> 
> I want to start documenting the APIs with docbook. I am currently learning
> about sgml and docbook to make it so. I hope to produce HTML docs like
> www.gtk.org. If the docs could be automatically generated from the source
> this would be perfect.
> 
> I suppose writing the overview and such could be done with docbook too.
> 
> Wim
> 
Well, docbook would be suited for the tutorial.... AFAIK, the GTK+
dodcumentation is made from comments in the .c files. I can't recommend
using docbook for this. There are way too many tags, and normal docbook
output somewhat is less than satisfactory for techdocs.

Nicholas


---------------------------------------------------
Get free personalized email at http://www.iname.com




More information about the gstreamer-devel mailing list