Re: revisiting gdoc

[Dirk Luetjens <dirk luedi oche de>]

Hello,

> gdoc is also C-only, which I don't like.
I although tried to use gdoc for a private project. I missed the support
for c++, too. 
A while ago I asked why we (ok, I'm not contributing any softwore
to gnome right now) are not using doc++. Perhaps we can patch it to gdoc++
so that it supports DocBook. The answer was, that it is to complex. I'm
not sure. I looked at it, and it seems very easy to me. 

The format we use now is 
/* 
 * Function: gnomo_do
 *
 * Parameters:
 *       GtkWidget *target
 *       int       gnomo_action
 *
 * Output:
 *       the number of gnomothings gnomoacted on.
 *
 * Description: 
 *  blah blah blah. 
 */
     
In doc++ this would look like:

/** blah blah blah.
    @param GtkWidget *target
    @param int       gnomo_action
    @return the number of gnomothings gnomoacted on. */
in front of the function description. 

This dosen't look too complex for me, and is less overhead. You have
a lot of other possiblities, support for c++, you get a class browser as a
html output, ...

I don't want to argue abaout which format looks better. Both needs some
time to get used to it. But if we have to improve a non sufficiant
documentation system I would suggest to enhance doc++ to produce DocBook.
It is under GPL.

Or don't we use it, 'cause KDE uses it? 

Just my 2 cents

Dirk