API Documentation

[Jasper Huijsmans]

On Thu, Jan 29, 2004 at 10:56:26PM +0100, Benedikt Meurer wrote:
...
> 
> I started with the utility stuff in libxfce4util, heres what I did sofar:
> http://www.home.unix-ag.org/bmeurer/xfce/API/
> 

Right, I just modified the gtk-doc style comments in
xfce-desktop-entry.c and turned them into doxygen style comments in the
header file. Seems to work nicely. 

I saw you didn't add the documentation itself yet, was there a reason
for that? 

We should install it somewhere as well, but I haven't looked at how to
do this yet. Also it would be nice to have some text on the main page. 

I just played around a bit and added a file called MAINPAGE to the docs 
directory with a very short introduction and added MAINPAGE to the INPUT 
variable in the Doxyfile. That seems to work well.

docs/MAINPAGE
==================================
/**

@mainpage Utility library for XFce

This library contains non-graphical utility functions for use by all
components of the XFce Desktop Environment:
- Debug functions.
- Internationalization functions.
- Location of user data.
- Manipulating UTF-8 text.
- Handling of desktop entry files.

*/
===================================

What do you think? 

	Jasper

PS
I'd also like to have an automatic index for API docs as well as regular
documentation, but that's a bit more involved ...