Re: API docs at d.g.o



Sounds good to me! It might be good to send the patch to the list first, just to be sure?

a.

On Wed, 2004-01-28 at 23:07 +0100, Matthias Clasen wrote:
I have taken a look at the api docs at
http://developer.gnome.org/doc/API/ and compared it to the list of
modules of the Developer Platform at
http://www.gnome.org/start/2.5/modules/. Here is what I found (omitting
modules which aren't libraries):

Docs are missing for at-spi, audiofile, gail, libIDL, libxslt. Of these,
at-spi and gail do have gtk-doc-generated api docs, libxslt has docs at
xmlsoft.org just like libxml, and AFAICS audiofile and libIDL don't have
docs. 

The following libraries aren't in the developer platform module list:
libpanel-applet, bonobo-activation. libpanel-applet is part of the
gnome-panel module which isn't in the Developer Platform, and
bonobo-activation has been merged into libbonobo, though the docs seem
to remain separate.

Here is what I would like to do:

- Rename the first section to "GNOME Developer Platform Libraries"
- Change all docs to track 2.5.x instead of 2.4 (this should not be a
problem, since the only differences between platform library versions
should be api additions, which should be marked by "Since: 2.x")
- Add at-spi, gail and libxslt docs
- Move libpanel-applet to the "GNOME Desktop Libraries" section
- Furthermore, one could look at improving the coverage of the 
"GNOME Desktop Libraries" section, but I'll concentrate on the the 
platform section for now.

Is that ok ? 

Matthias


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