diff options
| author | Björn Lindqvist <bjourne@gmail.com> | 2008-06-29 12:09:31 +0000 |
|---|---|---|
| committer | Björn Lindqvist <bjornl@src.gnome.org> | 2008-06-29 12:09:31 +0000 |
| commit | eba8246ce534aa2965e455d972b43e3053c6a84f (patch) | |
| tree | 56a3fa9021b67e18d40a6f0d20063278e3a6c1e1 /gobject/gobject.c | |
| parent | 9dc8ea91a2572fd3e9c57be633a7dae927d8f933 (diff) | |
Bug 539626 – Update docstrings for g_object_freeze_notify and
2008-06-29 Björn Lindqvist <bjourne@gmail.com>
Bug 539626 – Update docstrings for g_object_freeze_notify and
g_object_thaw_notify
* gobject/gobject.c: Explain how the freeze count works.
svn path=/trunk/; revision=7102
Diffstat (limited to 'gobject/gobject.c')
| -rw-r--r-- | gobject/gobject.c | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/gobject/gobject.c b/gobject/gobject.c index 86d7f7191..6a2a3704f 100644 --- a/gobject/gobject.c +++ b/gobject/gobject.c @@ -796,8 +796,10 @@ g_object_run_dispose (GObject *object) * g_object_freeze_notify: * @object: a #GObject * - * Stops emission of "notify" signals on @object. The signals are - * queued until g_object_thaw_notify() is called on @object. + * Increases the freeze count on @object. If the freeze count is + * non-zero, the emission of "notify" signals on @object is + * stopped. The signals are queued until the freeze count is decreased + * to zero. * * This is necessary for accessors that modify multiple properties to prevent * premature notification while the object is still being modified. @@ -863,8 +865,11 @@ g_object_notify (GObject *object, * g_object_thaw_notify: * @object: a #GObject * - * Reverts the effect of a previous call to g_object_freeze_notify(). - * This causes all queued "notify" signals on @object to be emitted. + * Reverts the effect of a previous call to + * g_object_freeze_notify(). The freeze count is decreased on @object + * and when it reaches zero, all queued "notify" signals are emitted. + * + * It is an error to call this function when the freeze count is zero. */ void g_object_thaw_notify (GObject *object) |