Re: ANNOUNCE: The GTK+ Reference Documentation Project

[David Helder <dhelder umich edu>]

Why not use a javadoc-like system where documentation can been written
along with the declarations in the headers?

The advantages are that:
* The documention can be kept up-to-date as development progresses.
* It encourages the developers to write the reference documentation, which
	they should be doing in the first place.
* It aids in debugging because the testers know what the functions do and
	can easily determine if they are performing correctly.

There may even be a program that will generate DocBook SGML DTD.  You
could even modify the gtk-doc scanner to grab comments in front of the
functions.

I would also encourage the developers not to accept any new code in 1.3
that isn't completely documented, with a tutorial.

Also, will the book be free?  Maybe the copyright should be assigned to
GNU or FSF, rather than the people publishing the book.

David

      __          _    __  
  ___/ /__ __  __(_)__/ /  David Helder - University of Michigan
 / _  / _ `/ |/ / / _  /   dhelder@umich.edu
 \_,_/\_,_/|___/_/\_,_/    http://www.eecs.umich.edu/~dhelder