Re: gtk-docs [was: Updated libgnomecanvas docs]



Rich Burridge wrote:

Hi Josh,

I don't know as to whether it supports C++ or not. My feeling is that it
probably doesn't support anything beyond just C with some stuff for
GObject hierarchy, properties and signals. Most of the work is done in
perl scripts, and that is often how I figured out its behavior is by
looking at the source. Good luck!

Are you (or is anyone else) interested in doing some more work with
the gtk-doc PERL scripts?  I'm part of a group of people that have
been putting together a proposed API for GNOME Speech v1.0. This API
is heavily influenced by the Java Speech API which has extensive JavaDoc
comments. We have used this to add extensive IDL style comments to the IDL files.

It sure would be nice, for somebody knowledgeable in PERL and/or gtk-doc
to be able to work out how to turn this into gtk-doc style documentation,
rather than forcing the developers to have to browser .idl files. Note
that this functionality would then be useful to several other GNOME modules
that have IDL files.
Please post to gtk-doc-list gnome org if you are interested in working on this. Most of the recent work on gtk-doc has been in making it easier to integrate documentation building in packages, and improving the XML code paths.

Knowing what people would like to use the tool for would be quite helpful in working out how to develop it further.

James.

--
Email: james daa com au
WWW:   http://www.daa.com.au/~james/






[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]