[at-spi2-core] Fix some warnings and documentation issues



commit a10ced48dd21a4aa62fc325d0ab2e52a78f2103e
Author: Mike Gorse <mgorse suse com>
Date:   Thu Oct 10 13:48:04 2013 -0500

    Fix some warnings and documentation issues

 atspi/atspi-collection.c |    1 +
 atspi/atspi-constants.h  |    2 +-
 atspi/atspi-gmain.c      |    8 -----
 atspi/atspi-misc.c       |   73 +++++-----------------------------------------
 atspi/atspi-registry.c   |    3 +-
 atspi/atspi-text.c       |    6 +---
 6 files changed, 13 insertions(+), 80 deletions(-)
---
diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c
index 9e1a7b5..f4e33ef 100644
--- a/atspi/atspi-collection.c
+++ b/atspi/atspi-collection.c
@@ -261,6 +261,7 @@ atspi_collection_get_matches_from (AtspiCollection *collection,
 /**
  * atspi_collection_get_active_descendant:
  *
+* Returns: (transfer full): The active descendant of the given object.
  * Not yet implemented.
  **/
 AtspiAccessible *
diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
index 4eb517e..13b0389 100644
--- a/atspi/atspi-constants.h
+++ b/atspi/atspi-constants.h
@@ -1031,7 +1031,7 @@ typedef enum {
  * contains a view of document content. #AtspiDocument frames may occur within
  * another #AtspiDocument instance, in which case the second  document may be
  * said to be embedded in the containing instance.  HTML frames are often
- * @ATSPI_ROLE_DOCUMENT_FRAME:  Either this object, or a singleton descendant, 
+ * ATSPI_ROLE_DOCUMENT_FRAME:  Either this object, or a singleton descendant, 
  * should implement the #AtspiDocument interface.
  * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
  * follows it in a document. The 'heading level' of the heading, if
diff --git a/atspi/atspi-gmain.c b/atspi/atspi-gmain.c
index 6498c0a..c8006f4 100644
--- a/atspi/atspi-gmain.c
+++ b/atspi/atspi-gmain.c
@@ -34,14 +34,6 @@
 #define N_(x) x
 
 /**
- * @defgroup DBusGLibInternals GLib bindings implementation details
- * @ingroup  DBusInternals
- * @brief Implementation details of GLib bindings
- *
- * @{
- */
-
-/**
  * DBusGMessageQueue:
  * A GSource subclass for dispatching DBusConnection messages.
  * We need this on top of the IO handlers, because sometimes
diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c
index 11c4d0f..2cc1e91 100644
--- a/atspi/atspi-misc.c
+++ b/atspi/atspi-misc.c
@@ -399,52 +399,6 @@ add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
   return (obj != NULL);
 }
 
-static void
-send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
-{
-  AtspiEvent e;
-
-  memset (&e, 0, sizeof (e));
-  e.type = (add? "object:children-changed:add": "object:children-changed:remove");
-  e.source = parent;
-  e.detail1 = g_list_index (parent->children, child);
-  e.detail2 = 0;
-  _atspi_send_event (&e);
-}
-
-static void
-unref_object_and_descendants (AtspiAccessible *obj)
-{
-  GList *l;
-
-  for (l = obj->children; l; l = l->next)
-  {
-    unref_object_and_descendants (l->data);
-  }
-  g_object_unref (obj);
-}
-
-static gboolean
-remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
-{
-  GList *l;
-  AtspiAccessible *child;
-
-  for (l = a->children; l; l = l->next)
-  {
-    child = l->data;
-    if (!strcmp (bus_name, child->parent.app->bus_name)) break;
-  }
-  if (!l)
-  {
-    return FALSE;
-  }
-  send_children_changed (a, child, FALSE);
-  a->children = g_list_remove (a->children, child);
-  unref_object_and_descendants (child);
-  return TRUE;
-}
-
 void
 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
 {
@@ -849,17 +803,6 @@ atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 }
 
-static const char *signal_interfaces[] =
-{
-  "org.a11y.atspi.Event.Object",
-  "org.a11y.atspi.Event.Window",
-  "org.a11y.atspi.Event.Mouse",
-  "org.a11y.atspi.Event.Terminal",
-  "org.a11y.atspi.Event.Document",
-  "org.a11y.atspi.Event.Focus",
-  NULL
-};
-
 /*
  * Returns a 'canonicalized' value for DISPLAY,
  * with the screen number stripped off if present.
@@ -1616,6 +1559,14 @@ atspi_get_a11y_bus (void)
 }
 
 /**
+ * atspi_set_timeout:
+ *  @val: The timeout value, in milliseconds, or -1 to disable the timeout.
+ *  @startup_time: The amount of time, in milliseconds, to allow to pass
+ *  before enforcing timeouts on an application. Can be used to prevent
+ *  timeout exceptions if an application is likely to block for an extended
+ *  period of time on initialization. -1 can be passed to disable this
+ *  behavior.
+ *
  *  Set the timeout used for method calls. If this is not set explicitly,
  *  a default of 0.8 ms is used.
  *  Note that at-spi2-registryd currently uses a timeout of 3 seconds when
@@ -1627,13 +1578,6 @@ atspi_get_a11y_bus (void)
  *  was not consumed), so this may make it undesirable to set a timeout
  *  larger than 3 seconds.
  *
- *  @val: The timeout value, in milliseconds, or -1 to disable the timeout.
- *  @startup_time: The amount of time, in milliseconds, to allow to pass
- *  before enforcing timeouts on an application. Can be used to prevent
- *  timeout exceptions if an application is likely to block for an extended
- *  period of time on initialization. -1 can be passed to disable this
- *  behavior.
- *
  * By default, the normal timeout is set to 800 ms, and the application startup
  * timeout is set to 15 seconds.
  */
@@ -1716,7 +1660,6 @@ atspi_role_get_name (AtspiRole role)
   gchar *retval = NULL;
   GTypeClass *type_class;
   GEnumValue *value;
-  const gchar *name = NULL;
 
   type_class = g_type_class_ref (ATSPI_TYPE_ROLE);
   g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), NULL);
diff --git a/atspi/atspi-registry.c b/atspi/atspi-registry.c
index 8722b37..c9b11f0 100644
--- a/atspi/atspi-registry.c
+++ b/atspi/atspi-registry.c
@@ -83,7 +83,8 @@ atspi_get_desktop (gint i)
  * this implementation always returns a #Garray with a single
  * #AtspiAccessible desktop.
  *
- * Returns: (transfer full): a #GArray of desktops.
+ * Returns: (element-type AtspiAccessible*) (transfer full): a #GArray of
+ * desktops.
  **/
 GArray *
 atspi_get_desktop_list ()
diff --git a/atspi/atspi-text.c b/atspi/atspi-text.c
index e84883e..645543a 100644
--- a/atspi/atspi-text.c
+++ b/atspi/atspi-text.c
@@ -423,13 +423,9 @@ atspi_text_get_text_before_offset (AtspiText *obj,
 
 /**
  * atspi_text_get_string_at_offset:
- * @text: an #AtspiText
+ * @obj: an #AtspiText
  * @offset: position
  * @granularity: An #AtspiTextGranularity
- * @start_offset: (out): the start offset of the returned string, or -1
- *                if an error has occurred (e.g. invalid offset, not implemented)
- * @end_offset: (out): the offset of the first character after the returned string,
- *              or -1 if an error has occurred (e.g. invalid offset, not implemented)
  *
  * Gets a portion of the text exposed through an #AtspiText according to a given @offset
  * and a specific @granularity, along with the start and end offsets defining the


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