Added better gtk-doc comments.

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

diff --git a/atk/atkrelationset.c b/atk/atkrelationset.c
index 1847663..89b8056 100755 (executable)
--- a/atk/atkrelationset.c
+++ b/atk/atkrelationset.c
@@ -57,10 +57,11 @@ atk_relation_set_class_init (AtkRelationSetClass *klass)
 }
 
 /**
- * atk_relation_set_new
- * return values: a new #AtkRelationSet 
+ * atk_relation_set_new:
  * 
  * Creates a new empty relation set.
+ * 
+ * Returns: a new #AtkRelationSet 
  **/
 AtkRelationSet*
 atk_relation_set_new (void)
@@ -72,13 +73,14 @@ atk_relation_set_new (void)
 }
 
 /**
- * atk_relation_set_contains
+ * atk_relation_set_contains:
  * @set: a #AtkRelationSet
- * @relationtype: a #AtkRelationType
- * return values: %TRUE if @relationtype is the relationship type of a relation in @set.
+ * @relationship: a #AtkRelationType
  *
  * Determines whether the relation set contains a relation that matches the
  * specified type.
+ *
+ * Returns: %TRUE if @relationtype is the relationship type of a relation in @set.
  **/
 gboolean
 atk_relation_set_contains (AtkRelationSet   *set,
@@ -104,12 +106,11 @@ atk_relation_set_contains (AtkRelationSet   *set,
 }
 
 /**
- * atk_relation_set_remove
+ * atk_relation_set_remove:
  * @set: a #AtkRelationSet
  * @relation: a #AtkRelation
  *
  * Removes a relation from the relation set.
- *
  * This function unref's the AtkRelation so it will be deleted unless there
  * is another reference to it.
  **/
@@ -134,13 +135,12 @@ atk_relation_set_remove (AtkRelationSet *set,
 }
 
 /**
- * atk_relation_set_add
+ * atk_relation_set_add:
  * @set: a #AtkRelationSet
  * @relation: a #AtkRelation
  *
  * Add a new relation to the current relation set if it is not already
  * present.
- *
  * This function ref's the AtkRelation so the caller of this function
  * should unref it to ensure that it will be destroyed when the AtkRelationSet
  * is destroyed.
@@ -162,11 +162,12 @@ atk_relation_set_add (AtkRelationSet *set,
 }
 
 /**
- * atk_relation_set_get_n_relations
+ * atk_relation_set_get_n_relations:
  * @set: a #AtkRelationSet
- * return values: a gint representing the number of relations in the set.
  *
  * Determines the number of relations in a relation set.
+ *
+ * Returns: a gint representing the number of relations in the set.
  **/
 gint
 atk_relation_set_get_n_relations (AtkRelationSet *set)
@@ -184,9 +185,10 @@ atk_relation_set_get_n_relations (AtkRelationSet *set)
  * atk_relation_set_get_relation
  * @set: a #AtkRelationSet
  * @i: a gint representing a position in the set, starting from 0.
- * return values: a #AtkRelation, which is the relation at position i in the set.
  *
  * Determines the relation at the specified position in the relation set.
+ *
+ * Returns: a #AtkRelation, which is the relation at position i in the set.
  **/
 AtkRelation*
 atk_relation_set_get_relation (AtkRelationSet *set,
@@ -210,12 +212,13 @@ atk_relation_set_get_relation (AtkRelationSet *set,
 }
 
 /**
- * atk_relation_set_get_relation_type
+ * atk_relation_set_get_relation_by_type:
  * @set: a #AtkRelationSet
  * @relationship: a #AtkRelationType
- * return values: a #AtkRelation, which is a relation matching the specified type.
  *
  * Finds a relation that matches the specified type.
+ *
+ * Returns: a #AtkRelation, which is a relation matching the specified type.
  **/
 AtkRelation*
 atk_relation_set_get_relation_by_type (AtkRelationSet  *set,