model: Add a comment on the n_columns field type

To avoid another bug report like:

  http://bugzilla.openedhand.com/show_bug.cgi?id=2017

with a patch that gets applied without a proper review, resulting in a
bug like:

  http://bugzilla.openedhand.com/show_bug.cgi?id=2032

I should probably add a comment on why on earth we're using an integer
as the n_columns member of the ClutterModelPrivate structure, and why it
is important that it is initialized as -1.
This commit is contained in:
Emmanuele Bassi 2010-03-16 18:57:28 +00:00
parent de4abfac95
commit 0a6497a3b6

View File

@ -193,6 +193,15 @@ struct _ClutterModelPrivate
{
GType *column_types;
gchar **column_names;
/* we use an integer here because we want to be able to use -1 as a
* guard value, to allow calling set_names() and set_types() from
* sub-classes of ClutterModel. see bug:
*
* http://bugzilla.openedhand.com/show_bug.cgi?id=2032
*
* for a reference.
*/
gint n_columns;
ClutterModelFilterFunc filter_func;