[at-spi2-core] Improving atspi-relation documentation.
- From: Mike Gorse <mgorse src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [at-spi2-core] Improving atspi-relation documentation.
- Date: Wed, 24 Aug 2011 17:10:17 +0000 (UTC)
commit a9b221b1083f08dd9a92de0958dddcc8c691a53e
Author: Aline Bessa <alibezz gmail com>
Date: Tue Aug 2 18:36:18 2011 -0300
Improving atspi-relation documentation.
atspi/atspi-relation.c | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/atspi/atspi-relation.c b/atspi/atspi-relation.c
index 60e8947..7493ecf 100644
--- a/atspi/atspi-relation.c
+++ b/atspi/atspi-relation.c
@@ -28,7 +28,7 @@
* atspi_relation_get_relation_type:
* @obj: a pointer to the #AtspiRelation object to query.
*
- * Get the type of relationship represented by an #AtspiRelation.
+ * Gets the type of relationship represented by an #AtspiRelation.
*
* Returns: an #AtspiRelationType indicating the type of relation
* encapsulated in this #AtspiRelation object.
@@ -44,12 +44,12 @@ atspi_relation_get_relation_type (AtspiRelation *obj)
* atspi_relation_get_n_targets:
* @obj: a pointer to the #AtspiRelation object to query.
*
- * Get the number of objects which this relationship has as its
- * target objects (the subject is the #Accessible from which this
+ * Gets the number of objects which this relationship has as its
+ * target objects (the subject is the #AtspiAccessible from which this
* #AtspiRelation originated).
*
- * Returns: a short integer indicating how many target objects which the
- * originating #Accessible object has the #AtspiRelation
+ * Returns: a #gint indicating how many target objects which the
+ * originating #AtspiAccessible object has the #AtspiRelation
* relationship with.
**/
gint
@@ -61,9 +61,9 @@ atspi_relation_get_n_targets (AtspiRelation *obj)
/**
* atspi_relation_get_target:
* @obj: a pointer to the #AtspiRelation object to query.
- * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
+ * @i: a (zero-index) #gint indicating which (of possibly several) target is requested.
*
- * Get the @i-th target of a specified #AtspiRelation relationship.
+ * Gets the @i-th target of a specified #AtspiRelation relationship.
*
* Returns: (transfer full): an #AtspiAccessible which is the @i-th object
* with which the originating #AtspiAccessible has relationship
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]