[Gtk-sharp-list] Full documentation by 1.0
Tue, 22 Jun 2004 08:23:45 -0500
On Mon, 2004-06-21 at 15:50 -0700, Brian Kerrick Nickel wrote:
> After wasting hours of my life trying to figure out Gdk.Pixdata.
> Serialize, it's become apparent to me that before Gtk# 1.0 comes out,
> the entire thing needs to be carefully documented for two reasons:
I committed some changes to Pixdata this weekend they should at least
make the api usable though not ideal.
> 1. No matter how good, simple, an easy to use an API is, if the
> only explanation as to what the function does it it's variable
> names, you're going to end up with lost and confused developers,
> such as myself.
> 2. The API has lots of little bugs. Documenting the API has forced
> me to look at the generated source and the gtk+ docs many times
> and when I have, I've found several functions passing or
> returning the wrong types, making them virtually worthless.
> Documenting is the second best way to find these bugs, the first
> being using the functions, but that could be difficult if they
> aren't documented :)
If you find unusable api keep track of it by opening bugs (you can cc me
on the bugs if you like). In my experience most of them are relatively
simple to fix now that the generator is more mature.