These changes improve the quality of the documentation by adding
[platform/upstream/atk.git] / docs / tmpl / atkrelation.sgml
index a357252..44611d9 100644 (file)
@@ -2,11 +2,16 @@
 AtkRelation
 
 <!-- ##### SECTION Short_Description ##### -->
-defines the functional relationship between two #AtkObjects
+An object usaed to describe a relation between a object and one or more
+other objects.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-Defines the functional relationship between two #AtkObjects.
+An AtkRelation describes a relation between the object and one or more
+other objects. The actual relations that an object has with other objects
+are defined as an AtkRelationSet, which is a set of AtkRelations.
+
+
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -14,6 +19,12 @@ Defines the functional relationship between two #AtkObjects.
 
 </para>
 
+<!-- ##### STRUCT AtkRelation ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### ENUM AtkRelationType ##### -->
 <para>
 
@@ -25,6 +36,7 @@ Defines the functional relationship between two #AtkObjects.
 @ATK_RELATION_LABEL_FOR: 
 @ATK_RELATION_LABELLED_BY: 
 @ATK_RELATION_MEMBER_OF: 
+@ATK_RELATION_NODE_CHILD_OF: 
 @ATK_RELATION_LAST_DEFINED: 
 
 <!-- ##### FUNCTION atk_relation_type_register ##### -->
@@ -36,6 +48,24 @@ Defines the functional relationship between two #AtkObjects.
 @Returns: 
 
 
+<!-- ##### FUNCTION atk_relation_type_get_name ##### -->
+<para>
+
+</para>
+
+@type: 
+@Returns: 
+
+
+<!-- ##### FUNCTION atk_relation_type_for_name ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
 <!-- ##### FUNCTION atk_relation_new ##### -->
 <para>