Added missing gtk-doc comments for atk_relation_type_from_string.
authorBill Haneman <billh@src.gnome.org>
Wed, 21 Nov 2001 23:15:33 +0000 (23:15 +0000)
committerBill Haneman <billh@src.gnome.org>
Wed, 21 Nov 2001 23:15:33 +0000 (23:15 +0000)
ChangeLog
atk/atkrelation.c

index 8a06736..0d9352d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2001-11-21  Bill Haneman <bill.haneman@sun.com>
+
+       * atk/atkrelation.c: Added gtk-doc docs for 
+       atk_relation_type_from_string.
+
 Wed Nov 21 17:54:44 2001  Owen Taylor  <otaylor@redhat.com>
 
        * atk/atkobject.h (enum): Fix trailing comma on
index 0511efb..deba01e 100755 (executable)
@@ -72,6 +72,16 @@ atk_relation_type_register (const gchar *name)
   return (++type);
 }
 
+
+/**
+ * atk_relation_type_from_string:
+ * @name: a string which is the (non-localized) name of an ATK relation type.
+ *
+ * Get the #AtkRelationType type corresponding to a relation name.
+ *
+ * Returns: the #AtkRelationType enumerated type corresponding to the specified name,
+ *          or #ATK_RELATION_NULL if no matching relation type is found.
+ **/
 AtkRelationType
 atk_relation_type_from_string (const gchar *name)
 {