Learn your lessons ; write good docs !
August 3, 2006
Hello,
As you read in previous post, i lake motivation to dive into the code and continue the hard work of the early stage of the project. With my mentor Vincent Untz, i decided to document the code. Documentation is a very important goal of this project. The GnomePrint project failed to provide a good documentation and that lead to an underused library. Luckly, GtkPrint in Gtk+ 2.10 is landing and we can expect good and common print dialogs. Reviewing the past weeks, it clearly appear that the most important parts of work in the Gnome Scan project are libgnomescan and libgnomescanui. That sound very similar to libgnomeprint and libgnome printui. This is why writing good docs was a lesson to learn from GnomePrint.
Of cours, gtk-doc is the definitive tool to document GObject API. gtk-doc is the only in-source documentation extractor able to parse GObject, properties, signals and object hierarchy. It also has nice feature like widget gallery and other hacks. The big problem about gtk-doc is that it is undocumented. An unfinished manual reside in the CVS, but most tricks are note documented. I spend quite 3 days to understand almost all i wanted from gtk-doc. In order to save a lot of ours to other developers, i created a wiki page documenting gtk-doc : http://live.gnome.org/DocumentationProject/GtkDoc. Feel free to complete and correct it.
I finally reach to write some good documentation of the API. My desktop computer is available at http://pigi.fr/. You can see the documentation at http://www.pigi.fr/bersace/flegita/doc/reference/libgnomescan/html/ and http://www.pigi.fr/bersace/flegita/doc/reference/libgnomescanui/html/ . I did not wrote turorial, I need further investigation in gtk-doc and a real stable API to do this. But that is planned.
Documenting the two library has been a opportunity to review all the code, unify the style (now a lot closer to Gtk+ one) and see what is wrong. I now have an idea of what improvements are need, what implementation is needed and i will do this in the next days. Luckly i now have the motivation to do the work. So let’s go and do that rocking Gimp plugin ! ;D
Back from Holydays
August 1, 2006
Hello everyone,
As some of you may noticed, i’m back from holydays. The first good news is : i continue ! Thanks to my mentor and Google, i passed the mi-term evaluation. So I’m awaking the GnomeScanning project. I have some lake of motivation :(. I have a few goals to reach the end of the SoC project :
- Complete current work.
- Document API.
- Gimp plug-in.
- debug, debug.
See you for a next release.