AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

widget: Fix gtk_widget_insert_after/before() docs

Browse Source 
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
This commit is contained in:
Kjell Ahlstedt 2017-06-06 14:57:52 +02:00
parent bffbfde10a
commit 1b697fd7c2
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
gtk/gtkwidget.c
View File

@ -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.