[gtk+] widget: Fix gtk_widget_insert_after/before() docs



commit 1b697fd7c26d6813bd6d3b793c626e634b5c03cd
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Tue Jun 6 14:57:52 2017 +0200

    widget: Fix gtk_widget_insert_after/before() docs
    
    Add beginning double asterisks and function names. Correct the parameter
    names (next/previous_child -> next/previous_sibling). Make the documentation
    of the two functions more similar.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=783445

 gtk/gtkwidget.c |   19 ++++++++++---------
 1 files changed, 10 insertions(+), 9 deletions(-)
---
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 527a34d..e215769 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -15464,15 +15464,16 @@ gtk_widget_get_prev_sibling (GtkWidget *widget)
   return widget->priv->prev_sibling;
 }
 
-/*
+/**
+ * gtk_widget_insert_after:
  * @widget: a #GtkWidget
  * @parent: the parent #GtkWidget to insert @widget into
- * @previous_child: (nullable): the new previous sibling of @widget
+ * @previous_sibling: (nullable): the new previous sibling of @widget or %NULL
  *
  * Inserts @widget into the child widget list of @parent.
- * It will be placed after @previous_child, or at the beginning if @previous_child is %NULL.
+ * It will be placed after @previous_sibling, or at the beginning if @previous_sibling is %NULL.
  *
- * After calling this function, gtk_widget_get_prev_sibling(widget) will return @previous_child.
+ * After calling this function, gtk_widget_get_prev_sibling(widget) will return @previous_sibling.
  *
  * If @parent is already set as the parent widget of @widget, this function can also be used
  * to reorder @widget in the child widget list of @parent.
@@ -15501,16 +15502,16 @@ gtk_widget_insert_after (GtkWidget *widget,
                                previous_sibling);
 }
 
-/*
+/**
+ * gtk_widget_insert_before:
  * @widget: a #GtkWidget
  * @parent: the parent #GtkWidget to insert @widget into
- * @next_child: (nullable): the new next sibling of @widget or %NULL
+ * @next_sibling: (nullable): the new next sibling of @widget or %NULL
  *
  * Inserts @widget into the child widget list of @parent.
- * It will be placed before @next_child, or at the end if @next_child is %NULL.
+ * It will be placed before @next_sibling, or at the end if @next_sibling is %NULL.
  *
- * After calling this function, gtk_widget_get_next_sibling(widget) will return @next_child
- * if @next_child was not %NULL.
+ * After calling this function, gtk_widget_get_next_sibling(widget) will return @next_sibling.
  *
  * If @parent is already set as the parent widget of @widget, this function can also be used
  * to reorder @widget in the child widget list of @parent.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]