[gtk/gtk3-selection-docs: 1/2] docs: Fix gtk_tree_selection_get_selected()
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/gtk3-selection-docs: 1/2] docs: Fix gtk_tree_selection_get_selected()
- Date: Wed, 29 Sep 2021 23:39:03 +0000 (UTC)
commit 4f54fcd2882f62bdd032434e46a8902d2077c02f
Author: Emmanuele Bassi <ebassi gnome org>
Date: Thu Sep 30 00:35:11 2021 +0100
docs: Fix gtk_tree_selection_get_selected()
Use the proper sigils for enumeration values and constants. The
description is also barely intelligible.
gtk/gtktreeselection.c | 22 ++++++++++++++--------
1 file changed, 14 insertions(+), 8 deletions(-)
---
diff --git a/gtk/gtktreeselection.c b/gtk/gtktreeselection.c
index 4da15db573..eb69a35412 100644
--- a/gtk/gtktreeselection.c
+++ b/gtk/gtktreeselection.c
@@ -460,16 +460,21 @@ gtk_tree_selection_get_tree_view (GtkTreeSelection *selection)
/**
* gtk_tree_selection_get_selected:
* @selection: A #GtkTreeSelection.
- * @model: (out) (allow-none) (transfer none): A pointer to set to the #GtkTreeModel, or NULL.
- * @iter: (out) (allow-none): The #GtkTreeIter, or NULL.
+ * @model: (out) (optional) (transfer none): the model
+ * @iter: (out) (optional): the iterator for the selected row
*
- * Sets @iter to the currently selected node if @selection is set to
- * #GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you
- * just want to test if @selection has any selected nodes. @model is filled
- * with the current model as a convenience. This function will not work if you
- * use @selection is #GTK_SELECTION_MULTIPLE.
+ * Sets @iter to the currently selected node, if @selection is set to
+ * %GTK_SELECTION_SINGLE or %GTK_SELECTION_BROWSE.
*
- * Returns: TRUE, if there is a selected node.
+ * The @iter argument may be %NULL if you just want to test if @selection
+ * has any selected nodes.
+ *
+ * The @model argument is filled with the current model as a convenience.
+ *
+ * This function will not work with %GTK_SELECTION_MULTIPLE. See
+ * gtk_tree_selection_get_selected_rows() instead.
+ *
+ * Returns: %TRUE, if there is a selected node.
**/
gboolean
gtk_tree_selection_get_selected (GtkTreeSelection *selection,
@@ -542,6 +547,7 @@ gtk_tree_selection_get_selected (GtkTreeSelection *selection,
* To do this, you can use gtk_tree_row_reference_new().
*
* To free the return value, use:
+ *
* |[<!-- language="C" -->
* g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);
* ]|
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]