Re: Some API doc status



On Thu, Mar 06, 2003 at 12:43:27AM +0100, Mikael Hallendal wrote:
> Hi!
> 
> Hopefully these numbers can inspire people to lift the documentation a
> couple of percent on various modules.

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.

And while I have the soapbox...

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.)

Thanks,
Malcolm

-- 
On the other hand, you have different fingers.



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