Re: Some API doc status

[Biswapesh Chattopadhyay <biswapesh_chatterjee tcscal co in>]

As I said before, it would really help us (Anjuta developers) if people
implemented a .devhelp file in the docs. Glib / Pango / GTK / Bonobo(UI)
do it (correctly) but no other it seems.

It should be < 1 hour job (perhaps < 30 minutes) even for someone
familiar with the package to copy the relevant bits from the Bonobo CVS
and implement it for the package.

Thanks and regards,
Biswa.

> 
> On Thu, Mar 06, 2003 at 10:52:25AM +1100, Malcolm Tredinnick wrote:
> 
> > Note that numbers like this can be slightly low if there are things in
> > *-unused.txt, since they do not get counted (until you add them to
> > *-sections.txt). But it's usually nothing too severe.
> 
> Of course, all definitions from *-unused.txt should be added to
> *-sections.txt, even if they are not and should not be documented.
> That's what the Standard and Private sections are for.
> 
> BTW: I've now slightly updated libgnomecanvas by moving *Priv structures
> into the Private section and by putting all class structures from
> unused.txt into the appropriate Standard sections. Now, it's at 78%
> documented.
> 
> > Can API documenters please add short descriptions in each of the *.tmpl
> > files so that others have some idea of what the particular groups of
> > functions are for. GLib, GTK+ and libglade are perfect examples, having
> > both short description strings and introductory paragraphs, giving as
> > much information as you might like. (I'm as guilty of these omissions as
> > everybody else, but that's no defence.)
> 
> Yes, please do. Also, examples can go a long way to explain the workings
> of a particular library feature or function.
> 
>  - Sebastian
> 
> _______________________________________________
> desktop-devel-list mailing list
> desktop-devel-list gnome org
> http://mail.gnome.org/mailman/listinfo/desktop-devel-list
> 
>