Automatic API doc for Gnome???

[Bertrand Guiheneuf <Bertrand Guiheneuf inria fr>]

Hi,

I don't know if the need for an automatic documentation program has been
discussed on this list. I think about a package which would parse C programs
and would use special comments (for example /** <title>blah blah</title> **/)
to generate a verbose automatic Api documentation (like javadoc) in DocBook.

I don't know if such a tool even makes sense, as I know that many programmers
would not like to include comments in their sources.

On the other hand, I can't figure how it would be possible to store the 
comments separately. A possible solution would be to use an XML file
as an intermediate, so that the programers can add (DocBook) text to the 
XML file without changing the C sources. The XML file and the C sources are
then read to generate a new XML files, so that the two files are synced.

This seems a bit tricky, and would need a XML->SGML stage.
On the other hand, the XML file could be reused by an IDE or any other gnome
prog.

Any comment?

	Bertrand

=======================================================================
  Bertrand GUIHENEUF           	E-Mail: bertrand.guiheneuf@inria.fr
                               	Tel.:   (33) 01 39 63 50 36
  				
                    !!  Use GNU/LINUX OS  !!
=======================================================================