summaryrefslogtreecommitdiff
path: root/atk/atkrelation.c
diff options
context:
space:
mode:
authorAlejandro Piñeiro <apinheiro@igalia.com>2013-08-12 17:07:46 +0200
committerAlejandro Piñeiro <apinheiro@igalia.com>2013-08-12 21:06:36 +0200
commit0f1e31ad2451b1e00f631e217d9d29d306404f2d (patch)
tree9df22ec49c982912979aa6b907dd25dc27fccd96 /atk/atkrelation.c
parentc568794a6f75cc9cc297b24978bc7480ee689bea (diff)
downloadatk-0f1e31ad2451b1e00f631e217d9d29d306404f2d.tar.gz
doc: removing several .sgml files and fixing gtk-doc warnings
The static documentation of those .sgml (so the reason of tracking those objects) where moved to the source files. Some other stuff was changed in order to prevent gtk-doc warnings (like replacing "Returns blah" for the correct "Returns: blah") https://bugzilla.gnome.org/show_bug.cgi?id=684665
Diffstat (limited to 'atk/atkrelation.c')
-rwxr-xr-xatk/atkrelation.c13
1 files changed, 12 insertions, 1 deletions
diff --git a/atk/atkrelation.c b/atk/atkrelation.c
index cc1807e..b6ba50f 100755
--- a/atk/atkrelation.c
+++ b/atk/atkrelation.c
@@ -23,6 +23,17 @@
#include "atkrelation.h"
#include "atk-enum-types.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,
@@ -341,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