X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=atk%2Fatkrelation.c;h=6dcb1c477e55bf1a104bd8cd5bdaee3f8ee51001;hb=c5ee728c20b2d04aa69f21feefcbdd8c6ca0ba36;hp=171d4f3f929b78f0a6fd449fefd13ed74bb5469f;hpb=2b6504ef3a8eb22b4d00c933e041fe2e1423142a;p=platform%2Fupstream%2Fatk.git diff --git a/atk/atkrelation.c b/atk/atkrelation.c old mode 100755 new mode 100644 index 171d4f3..6dcb1c4 --- a/atk/atkrelation.c +++ b/atk/atkrelation.c @@ -17,12 +17,23 @@ * Boston, MA 02111-1307, USA. */ +#include "config.h" + #include #include -#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, @@ -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: (transfer none): the target list of @relation + * Returns: (transfer none) (element-type Atk.Object): the target list of @relation **/ GPtrArray* atk_relation_get_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