summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Cameron <bcameron@src.gnome.org>2001-06-15 16:16:35 +0000
committerBrian Cameron <bcameron@src.gnome.org>2001-06-15 16:16:35 +0000
commit1f0e6b56702ffcd0c0bd48cf2915a4c36b97dde4 (patch)
tree79570d6c89389cac6b08217a9bcddb794e7f7c0d
parent59a116c288177b92bd087169753ea54870d9fcd0 (diff)
downloadatk-1f0e6b56702ffcd0c0bd48cf2915a4c36b97dde4.tar.gz
Made docs more clear.
-rwxr-xr-xatk/atkselection.c10
-rwxr-xr-xatk/atktext.c3
2 files changed, 7 insertions, 6 deletions
diff --git a/atk/atkselection.c b/atk/atkselection.c
index 4532ff4..d4dc14a 100755
--- a/atk/atkselection.c
+++ b/atk/atkselection.c
@@ -42,7 +42,7 @@ atk_selection_get_type ()
/**
* atk_selection_add_selection:
* @selection: a #GObject instance that implements AtkSelectionIface
- * @i: a #gint specifying an accessible child of @selection
+ * @i: a #gint specifying the child index.
*
* Adds the specified accessible child of the object to the
* object's selection.
@@ -94,7 +94,8 @@ atk_selection_clear_selection (AtkSelection *obj)
/**
* atk_selection_ref_selection:
* @selection: a #GObject instance that implements AtkSelectionIface
- * @i: a #gint specifying an accessible child of @selection
+ * @i: a #gint specifying the index in the selection set. (e.g. the
+ * ith selection as opposed to the ith child).
*
* Gets a reference to the accessible object representing the specified
* selected child of the object.
@@ -155,7 +156,7 @@ atk_selection_get_selection_count (AtkSelection *obj)
/**
* atk_selection_is_child_selected:
* @selection: a #GObject instance that implements AtkSelectionIface
- * @i: a #gint specifying an accessible child of @selection
+ * @i: a #gint specifying the child index.
*
* Determines if the current child of this object is selected
* Note: callers should not rely on %NULL or on a zero value for
@@ -186,7 +187,8 @@ atk_selection_is_child_selected (AtkSelection *obj,
/**
* atk_selection_remove_selection:
* @selection: a #GObject instance that implements AtkSelectionIface
- * @i: a #gint specifying an accessible child of @selection
+ * @i: a #gint specifying the index in the selection set. (e.g. the
+ * ith selection as opposed to the ith child).
*
* Removes the specified child of the object from the object's selection.
*
diff --git a/atk/atktext.c b/atk/atktext.c
index c8d56fc..95b18b8 100755
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -272,8 +272,7 @@ atk_text_get_text_before_offset (AtkText *text,
*
* Gets the offset position of the caret (cursor).
*
- * Returns: the offset position of the caret (cursor), or -1 if
- * one does not exist (or is not supported by the widget).
+ * Returns: the offset position of the caret (cursor).
**/
gint
atk_text_get_caret_offset (AtkText *text)