[gtk+] ComboBox: Clarify documentation of get_active_iter
- From: Daniel Boles <dboles src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] ComboBox: Clarify documentation of get_active_iter
- Date: Thu, 24 Aug 2017 20:43:08 +0000 (UTC)
commit 73c689eb5a4aa432720cfa07d85671b13eedacc5
Author: Daniel Boles <dboles src gnome org>
Date: Thu Aug 24 12:46:47 2017 +0100
ComboBox: Clarify documentation of get_active_iter
https://bugzilla.gnome.org/show_bug.cgi?id=618160
gtk/gtkcombobox.c | 7 ++++---
1 files changed, 4 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c
index 1ddbbe3..474eb21 100644
--- a/gtk/gtkcombobox.c
+++ b/gtk/gtkcombobox.c
@@ -2377,11 +2377,12 @@ gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
/**
* gtk_combo_box_get_active_iter:
* @combo_box: A #GtkComboBox
- * @iter: (out): The uninitialized #GtkTreeIter
+ * @iter: (out): A #GtkTreeIter
*
- * Sets @iter to point to the current active item, if it exists.
+ * Sets @iter to point to the currently active item, if any item is active.
+ * Otherwise, @iter is left unchanged.
*
- * Returns: %TRUE, if @iter was set
+ * Returns: %TRUE if @iter was set, %FALSE otherwise
*
* Since: 2.4
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]