[atk/docs-fixes: 49/56] Add missing documentation for AtkObject functions
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [atk/docs-fixes: 49/56] Add missing documentation for AtkObject functions
- Date: Fri, 14 Jun 2019 15:50:48 +0000 (UTC)
commit 1baed9664d86f8975271e85c2bfdff08d694d4b2
Author: Emmanuele Bassi <ebassi gnome org>
Date: Tue Jun 26 17:03:18 2018 +0100
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.
atk/atkobject.c | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
---
diff --git a/atk/atkobject.c b/atk/atkobject.c
index 110bf2e..63986dd 100644
--- a/atk/atkobject.c
+++ b/atk/atkobject.c
@@ -1171,12 +1171,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)
@@ -1198,10 +1200,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)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]