From: Axel S. <A....@uk...> - 2002-10-21 11:40:38
|
On Mon, Oct 21, 2002 at 11:51:19AM +0900, Jens Petersen wrote: > > - under gendoc/ there is a first draft of a program which parses all the > > widget files and generates Docbook XML documentation. There is no Makefile > > magic yet and the process is rather involved, see the very end of this > > mail. Have a look at > > > > http://www.cs.ukc.ac.uk/people/staff/as49/gtk2hs > > > > to see how it looks like right now. > > I noticed you currently only have the mogul API appearing, I > hope you're also planning to generate documentation for the > gtk API too? Mogul doesn't add a lot on top of Gtk, there are merely some convenience functions, so I would like every user to use Mogul. For the documentation I would like to write some introductory text for the library. This text will be bundled with the Mogul API. A second book will describe the Gtk stuff, but only as a reference. I intend to turn the "todo" sections into "implementation note" and they will only appear in the Gtk reference. This is my current plan (which I made up over the weekend). I know that people will probably be reluctant to use "Modul" when they don't see the reason for that. I hope to get that point across in the documentation. Cheers, Axel. |