diff options
| author | Emmanuele Bassi <ebassi@gnome.org> | 2018-06-26 17:03:18 +0100 |
|---|---|---|
| committer | Emmanuele Bassi <ebassi@gnome.org> | 2018-06-26 17:03:18 +0100 |
| commit | 190835cf7129898c739ef3ba2af9d3c9c68dfc39 (patch) | |
| tree | 1a6e533dc7ef35b3cf80431cb2eae172fa93fc9e | |
| parent | cbad47790b73f640fc24c0f0f941fbd09927f282 (diff) | |
| download | atk-190835cf7129898c739ef3ba2af9d3c9c68dfc39.tar.gz | |
Add missing documentation for AtkObject functions
The deprecated functions for connecting and removing a handler for
property notification are missing a description, and use the wrong
syntax for the deprecation notice.
| -rw-r--r-- | atk/atkobject.c | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/atk/atkobject.c b/atk/atkobject.c index f8e855e..b76ee74 100644 --- a/atk/atkobject.c +++ b/atk/atkobject.c @@ -1137,12 +1137,14 @@ atk_object_set_role (AtkObject *accessible, * @accessible: an #AtkObject * @handler: a function to be called when a property changes its value * - * Deprecated: Since 2.12. Connect directly to property-change or - * notify signals. + * Calls @handler on property changes. * * Returns: a #guint which is the handler id used in - * atk_object_remove_property_change_handler() - **/ + * atk_object_remove_property_change_handler() + * + * Deprecated: 2.12: Connect directly to #AtkObject::property-change or + * the relevant #GObject::notify signal for each desired property. + */ guint atk_object_connect_property_change_handler (AtkObject *accessible, AtkPropertyChangeHandler *handler) @@ -1164,10 +1166,10 @@ atk_object_connect_property_change_handler (AtkObject *accessible, * @accessible: an #AtkObject * @handler_id: a guint which identifies the handler to be removed. * - * Deprecated: Since 2.12. - * * Removes a property change handler. - **/ + * + * Deprecated: 2.12: See atk_object_connect_property_change_handler() + */ void atk_object_remove_property_change_handler (AtkObject *accessible, guint handler_id) |