win32/vsX: Fix 'make dist'
[platform/upstream/atk.git] / atk / atkrelation.c
old mode 100755 (executable)
new mode 100644 (file)
index da9cdb7..6dcb1c4
  * Boston, MA 02111-1307, USA.
  */
 
+#include "config.h"
+
 #include <string.h>
 #include <glib-object.h>
-#include "atkobject.h"
-#include "atkrelation.h"
-#include "atk-enum-types.h"
+#include "atk.h"
 
+/**
+ * SECTION:atkrelation
+ * @Short_description: An object used to describe a relation between a
+ *  object and one or more other objects.
+ * @Title:AtkRelation
+ *
+ * An AtkRelation describes a relation between an 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.
+ */
 enum {
   PROP_0,
 
@@ -130,7 +141,7 @@ atk_relation_type_register (const gchar *name)
  *
  * Returns: the string describing the AtkRelationType
  */
-G_CONST_RETURN gchar*
+const gchar*
 atk_relation_type_get_name (AtkRelationType type)
 {
   GTypeClass *type_class;
@@ -217,7 +228,8 @@ atk_relation_type_for_name (const gchar *name)
 
 /**
  * atk_relation_new:
- * @targets: an array of pointers to #AtkObjects  
+ * @targets: (array length=n_targets): an array of pointers to
+ *  #AtkObjects
  * @n_targets: number of #AtkObjects pointed to by @targets
  * @relationship: an #AtkRelationType with which to create the new
  *  #AtkRelation
@@ -282,7 +294,7 @@ atk_relation_get_relation_type (AtkRelation *relation)
  *
  * Gets the target list of @relation
  *
- * Returns: the target list of @relation
+ * Returns: (transfer none) (element-type Atk.Object): the target list of @relation
  **/
 GPtrArray*
 atk_relation_get_target (AtkRelation *relation)
@@ -313,7 +325,7 @@ delete_object_while_in_relation (gpointer callback_data,
  * not already present.  See also atk_object_add_relationship().
  *
  *
- * Since: ATK 1.9
+ * Since: 1.9
  **/
 void
 atk_relation_add_target (AtkRelation *relation,
@@ -340,7 +352,7 @@ atk_relation_add_target (AtkRelation *relation,
  *
  * Remove the specified AtkObject from the target for the relation.
  *
- * Returns TRUE if the removal is successful.
+ * Returns: TRUE if the removal is successful.
  **/
 
 gboolean