Added better gtk-doc comments.

[platform/upstream/atk.git] / atk / atkstateset.c

diff --git a/atk/atkstateset.c b/atk/atkstateset.c
index 6c80021..7ff9348 100755 (executable)
--- a/atk/atkstateset.c
+++ b/atk/atkstateset.c
@@ -65,10 +65,11 @@ atk_state_set_class_init (AtkStateSetClass *klass)
 }
 
 /**
- * atk_state_set_new
- * return values: a new #AtkStateSet 
+ * atk_state_set_new:
  * 
  * Creates a new empty state set.
+ * 
+ * Returns: a new #AtkStateSet 
  **/
 AtkStateSet*
 atk_state_set_new (void)
@@ -77,11 +78,12 @@ atk_state_set_new (void)
 }
 
 /**
- * atk_state_set_is_empty
- * @type: a #AtkStateType
- * return values: %TRUE if @set has no states set
+ * atk_state_set_is_empty:
+ * @set: a #AtkStateType
  *
  * Checks whether the state set is empty, i.e. has no states set.
+ *
+ * Returns: %TRUE if @set has no states set
  **/
 gboolean
 atk_state_set_is_empty (AtkStateSet   *set)
@@ -99,13 +101,14 @@ atk_state_set_is_empty (AtkStateSet   *set)
 }
 
 /**
- * atk_state_set_add_state
+ * atk_state_set_add_state:
  * @set: a #AtkStateSet
  * @type: a #AtkStateType
- * return values: %TRUE if  the state for @type is not already in @set.
  *
  * Add a new state for the specified type to the current state set if
  * it is not already present
+ *
+ * Returns: %TRUE if  the state for @type is not already in @set.
  **/
 gboolean
 atk_state_set_add_state (AtkStateSet   *set,
@@ -126,7 +129,7 @@ atk_state_set_add_state (AtkStateSet   *set,
   }
 }
 /**
- * atk_state_set_add_states
+ * atk_state_set_add_states:
  * @set: a #AtkStateSet
  * @types: a array of #AtkStateType
  * @n_types: The number of elements in the array
@@ -152,7 +155,7 @@ atk_state_set_add_states (AtkStateSet   *set,
 }
 
 /**
- * atk_state_set_clear_states
+ * atk_state_set_clear_states:
  * @set: a #AtkStateSet
  *
  * Removes all states from the state set.
@@ -170,12 +173,13 @@ atk_state_set_clear_states (AtkStateSet   *set)
 }
 
 /**
- * atk_state_set_contains_state
+ * atk_state_set_contains_state:
  * @set: a #AtkStateSet
  * @type: a #AtkStateType
- * return values: %TRUE if @type is the state type is in @set.
  *
  * Checks whether the state for the specified type is in the specified set.
+ *
+ * Returns: %TRUE if @type is the state type is in @set.
  **/
 gboolean
 atk_state_set_contains_state (AtkStateSet   *set,
@@ -194,14 +198,15 @@ atk_state_set_contains_state (AtkStateSet   *set,
 }
 
 /**
- * atk_state_set_contains_states
+ * atk_state_set_contains_states:
  * @set: a #AtkStateSet
  * @types: a array of #AtkStateType
  * @n_types: The number of elements in the array
- * return values: %TRUE if all the states for @type are in @set.
  *
  * Checks whether the states for all the specified types are in the 
  * specified set.
+ *
+ * Returns: %TRUE if all the states for @type are in @set.
  **/
 gboolean
 atk_state_set_contains_states (AtkStateSet   *set,
@@ -224,12 +229,13 @@ atk_state_set_contains_states (AtkStateSet   *set,
 }
 
 /**
- * atk_state_set_remove_state
+ * atk_state_set_remove_state:
  * @set: a #AtkStateSet
  * @type: a #AtkType
- * return values: %TRUE if @type was the state type is in @set.
  *
  * Removes the state for the specified type from the state set.
+ *
+ * Returns: %TRUE if @type was the state type is in @set.
  **/
 gboolean
 atk_state_set_remove_state (AtkStateSet  *set,
@@ -251,13 +257,14 @@ atk_state_set_remove_state (AtkStateSet  *set,
 }
 
 /**
- * atk_state_set_and_sets
+ * atk_state_set_and_sets:
  * @set: a #AtkStateSet
  * @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which is the intersection of the two sets.
  *
  * Constructs the intersection of the two sets, returning NULL if the
  * intersection is empty.
+ *
+ * Returns: a new #AtkStateSet which is the intersection of the two sets.
  **/
 AtkStateSet*
 atk_state_set_and_sets (AtkStateSet  *set,
@@ -285,12 +292,13 @@ atk_state_set_and_sets (AtkStateSet  *set,
 }
 
 /**
- * atk_state_set_or_sets
+ * atk_state_set_or_sets:
  * @set: a #AtkStateSet
  * @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which is the union of the two sets.
  *
  * Constructs the union of the two sets.
+ *
+ * Returns: a new #AtkStateSet which is the union of the two sets.
  **/
 AtkStateSet*
 atk_state_set_or_sets (AtkStateSet  *set,
@@ -317,12 +325,13 @@ atk_state_set_or_sets (AtkStateSet  *set,
 }
 
 /**
- * atk_state_set_xor_sets
+ * atk_state_set_xor_sets:
  * @set: a #AtkStateSet
  * @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which contains the states which are in exactly one of ht two sets.
  *
  * Constructs the xor of the two sets, returing NULL is empty. The set returned by this operation contains the4 sattes in exactly one of the two sets.
+ *
+ * Returns: a new #AtkStateSet which contains the states which are in exactly one of ht two sets.
  **/
 AtkStateSet*
 atk_state_set_xor_sets (AtkStateSet  *set,