Fix atspi_text_get_bounded_ranges

[platform/upstream/at-spi2-core.git] / atspi / atspi-stateset.c

diff --git a/atspi/atspi-stateset.c b/atspi/atspi-stateset.c
index 28e272f..33c28a7 100644 (file)
--- a/atspi/atspi-stateset.c
+++ b/atspi/atspi-stateset.c
@@ -39,11 +39,12 @@ atspi_state_set_class_init (AtspiStateSetClass* klass)
 {
 }
 
-/*
+/**
  * atspi_state_set_new:
+ * @states: (element-type AtspiStateType): An array of states with which the
+ *          method initializes the state set.
  *
- * @states: (element-type AtspiStateType): An array of states with which to initialize
- * the state set.
+ * Generates an #AtspiStateSet with the given @states.
  *
  * Returns: A new #AtspiStateSet with the given states.
  **/
@@ -74,6 +75,15 @@ _atspi_state_set_new_internal (AtspiAccessible *accessible, gint64 states)
   return set;
 }
 
+/**
+ * atspi_state_set_set_by_name:
+ * @set: a pointer to the #AtspiStateSet object on which to operate.
+ * @name: a string corresponding to a state name.
+ * @enabled: if #TRUE, @name should be enabled in the @set in question;
+ *          otherwise, it should be disabled.
+ *
+ * Enables/disables a state in an #AtspiStateSet according to its @name.
+ **/
 void
 atspi_state_set_set_by_name (AtspiStateSet *set, const gchar *name, gboolean enabled)
 {
@@ -120,12 +130,11 @@ refresh_states (AtspiStateSet *set)
 
 /**
  * atspi_state_set_add:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
  * @state: an #AtspiStateType to be added to the specified #AtspiStateSet.
  *
- * Add a particular #AtspiState to an #AtspiStateSet (i.e. set the
- *       given state to #TRUE in the stateset.
+ * Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the
+ *       given state to #TRUE in the stateset).
  *
  **/
 void
@@ -138,14 +147,14 @@ atspi_state_set_add (AtspiStateSet *set, AtspiStateType state)
 /**
  * atspi_state_set_compare:
  * @set: a pointer to the first #AtspiStateSet object on which to operate.
- * @set: a pointer to the second #AtspiStateSet setect on which to operate.
+ * @set2: a pointer to the second #AtspiStateSet object on which to operate.
+ *
+ * Determines the differences between two instances of #AtspiStateSet.
  *
- * Determine the differences between two instances of #AtspiStateSet.
- *.
- * @see AtspiStateSet_equals().
+ * @see #atspi_state_set_equals.
  *
  * Returns: (transfer full): an #AtspiStateSet object containing all states
- *          contained on one of the two sets but not the other.
+ * contained on one of the two sets but not the other.
  *
  **/
 AtspiStateSet *
@@ -162,10 +171,10 @@ atspi_state_set_compare (AtspiStateSet *set,
  * atspi_state_set_contains:
  * @set: a pointer to the #AtspiStateSet object on which to operate.
  * @state: an #AtspiStateType for which the specified #AtspiStateSet
- *       will be queried.
+ *          will be queried.
  *
- * Determine whether a given #AtspiStateSet includes a given state; that is,
- *       whether @state is true for the stateset in question.
+ * Determines whether a given #AtspiStateSet includes a given state; that is,
+ *          whether @state is true for the @set in question.
  *
  * Returns: #TRUE if @state is true/included in the given #AtspiStateSet,
  *          otherwise #FALSE.
@@ -186,14 +195,14 @@ atspi_state_set_contains (AtspiStateSet *set,
  * @set: a pointer to the first #AtspiStateSet object on which to operate.
  * @set2: a pointer to the second #AtspiStateSet object on which to operate.
  *
- * Determine whether two instances of #AtspiStateSet are equivalent (i.e.
- *         consist of the same #AtspiStates).  Useful for checking multiple
- *         state variables at once; construct the target state then compare against it.
+ * Determines whether two instances of #AtspiStateSet are equivalent (i.e.
+ *          consist of the same #AtspiStates).  Useful for checking multiple
+ *          state variables at once.
  *
- * @see AtspiStateSet_compare().
+ * @see #atspi_state_set_compare.
  *
  * Returns: #TRUE if the two #AtspiStateSets are equivalent,
- *          otherwise #FALSE.
+ * otherwise #FALSE.
  *
  **/
 gboolean
@@ -209,10 +218,9 @@ atspi_state_set_equals (AtspiStateSet *set,
 
 /**
  * atspi_state_set_get_states:
- *
  * @set: The #AtspiStateSet to be queried.
  *
- * Return the states in an #AtspiStateSet as an array.
+ * Returns the states in an #AtspiStateSet as an array.
  *
  * Returns: (element-type AtspiStateType) (transfer full): A #GArray of state
  *          types representing the current state.
@@ -232,11 +240,7 @@ atspi_state_set_get_states (AtspiStateSet *set)
   for (i = 0; i < 64; i++)
   {
     if (set->states & val)
-    {
-      GArray *new_array = g_array_append_val (ret, i);
-      if (new_array)
-        ret = new_array;
-    }
+      ret = g_array_append_val (ret, i);
     val <<= 1;
   }
   return ret;
@@ -244,7 +248,6 @@ atspi_state_set_get_states (AtspiStateSet *set)
 
 /**
  * atspi_state_set_is_empty:
- *
  * @set: The #AtspiStateSet to query.
  *
  * Returns: #TRUE if the state set contains no states; #FALSE otherwise.
@@ -257,11 +260,10 @@ atspi_state_set_is_empty (AtspiStateSet *set)
 
 /**
  * atspi_state_set_remove:
- *
  * @set: a pointer to the #AtspiStateSet object on which to operate.
- * @state: an #AtspiStateType to remove from the specifiedn state set.
+ * @state: an #AtspiStateType to remove from the specified @set.
  *
- * Remove a particular #AtspiState to an #AtspiStateSet (i.e. set the
+ * Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the
  *       given state to #FALSE in the stateset.)
  *
  **/
@@ -271,4 +273,3 @@ atspi_state_set_remove (AtspiStateSet *set, AtspiStateType state)
   g_return_if_fail (set != NULL);
   set->states &= ~((gint64)1 << state);
 }
-