Re: GObject docs improvements





Thanks for doing this, this is really important and it's been incomplete for too long.


Stefan Kost wrote:

GType's Interfaces are very similar to Java's interfaces. They allow
to describe a common API that several classes will adhere to.
Imagine the play, pause and stop buttons on hifi equipment - those can
be seen as a playback interface. Once you know what the do, you can
control your cd-player, mp3-player or anything that uses these symbols.
To declare an interfacce you have to register a non-instantiable ...

It would be much better to simply mention each thing that constitutes a GType interface, rather than by analogy to Java or CD players or anything else; doing that is just confusing and really conveys no practical information to someone trying to find out how to go about implementing a GObject type.

The most important thing you can include is a complete and correct example of a real GObject that extends a real Glib or GTK Gobject type that can be used in an application (outside of GLib). Annotate it to show which things are optional or that you need to specify for your own type (vs. what's constant boilerplate).

For a lot of us, we don't care if some parts of how Gobject and types are implemented in GLib is mysterious, we just need to know how to use it in very practical sense.

Reed


PS in the docs in svn, "instantiate" is sometimes spelled incorrectly (for English :) as "instanciate"



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]