Formatting fixes and whitespace cleanups

This commit is contained in:
Matthias Clasen 2011-01-04 02:21:38 -05:00
parent 32bfc980c1
commit 7352a166b6

View File

@ -22,7 +22,7 @@
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
* GTK+ at ftp:ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
@ -978,7 +978,7 @@ gtk_notebook_class_init (GtkNotebookClass *class)
* right after a page has been reordered.
*
* Since: 2.10
**/
*/
notebook_signals[PAGE_REORDERED] =
g_signal_new (I_("page-reordered"),
G_TYPE_FROM_CLASS (gobject_class),
@ -999,7 +999,7 @@ gtk_notebook_class_init (GtkNotebookClass *class)
* right after a page is removed from the notebook.
*
* Since: 2.10
**/
*/
notebook_signals[PAGE_REMOVED] =
g_signal_new (I_("page-removed"),
G_TYPE_FROM_CLASS (gobject_class),
@ -1020,7 +1020,7 @@ gtk_notebook_class_init (GtkNotebookClass *class)
* right after a page is added to the notebook.
*
* Since: 2.10
**/
*/
notebook_signals[PAGE_ADDED] =
g_signal_new (I_("page-added"),
G_TYPE_FROM_CLASS (gobject_class),
@ -1534,7 +1534,7 @@ gtk_notebook_reorder_tab (GtkNotebook *notebook,
* Creates a new #GtkNotebook widget with no pages.
* Return value: the newly created #GtkNotebook
**/
*/
GtkWidget*
gtk_notebook_new (void)
{
@ -6496,15 +6496,15 @@ gtk_notebook_menu_detacher (GtkWidget *widget,
/**
* gtk_notebook_append_page:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
*
* Appends a page to @notebook.
*
* Return value: the index (starting from 0) of the appended
* page in the notebook, or -1 if function fails
**/
*/
gint
gtk_notebook_append_page (GtkNotebook *notebook,
GtkWidget *child,
@ -6520,22 +6520,22 @@ gtk_notebook_append_page (GtkNotebook *notebook,
/**
* gtk_notebook_append_page_menu:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @menu_label: (allow-none): the widget to use as a label for the page-switch
* menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be
* a newly created label with the same text as @tab_label;
* If @tab_label is not a #GtkLabel, @menu_label must be
* specified if the page-switch menu is to be used.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
* @menu_label: (allow-none): the widget to use as a label for the
* page-switch menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be a newly
* created label with the same text as @tab_label; if @tab_label
* is not a #GtkLabel, @menu_label must be specified if the
* page-switch menu is to be used.
*
* Appends a page to @notebook, specifying the widget to use as the
* label in the popup menu.
*
* Return value: the index (starting from 0) of the appended
* page in the notebook, or -1 if function fails
**/
*/
gint
gtk_notebook_append_page_menu (GtkNotebook *notebook,
GtkWidget *child,
@ -6553,15 +6553,15 @@ gtk_notebook_append_page_menu (GtkNotebook *notebook,
/**
* gtk_notebook_prepend_page:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
*
* Prepends a page to @notebook.
*
* Return value: the index (starting from 0) of the prepended
* page in the notebook, or -1 if function fails
**/
*/
gint
gtk_notebook_prepend_page (GtkNotebook *notebook,
GtkWidget *child,
@ -6577,22 +6577,22 @@ gtk_notebook_prepend_page (GtkNotebook *notebook,
/**
* gtk_notebook_prepend_page_menu:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @menu_label: (allow-none): the widget to use as a label for the page-switch
* menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be
* a newly created label with the same text as @tab_label;
* If @tab_label is not a #GtkLabel, @menu_label must be
* specified if the page-switch menu is to be used.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
* @menu_label: (allow-none): the widget to use as a label for the
* page-switch menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be a newly
* created label with the same text as @tab_label; if @tab_label
* is not a #GtkLabel, @menu_label must be specified if the
* page-switch menu is to be used.
*
* Prepends a page to @notebook, specifying the widget to use as the
* label in the popup menu.
*
* Return value: the index (starting from 0) of the prepended
* page in the notebook, or -1 if function fails
**/
*/
gint
gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
GtkWidget *child,
@ -6610,17 +6610,17 @@ gtk_notebook_prepend_page_menu (GtkNotebook *notebook,
/**
* gtk_notebook_insert_page:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
* @position: the index (starting at 0) at which to insert the page,
* or -1 to append the page after all other pages.
* or -1 to append the page after all other pages
*
* Insert a page into @notebook at the given position.
*
* Return value: the index (starting from 0) of the inserted
* page in the notebook, or -1 if function fails
**/
*/
gint
gtk_notebook_insert_page (GtkNotebook *notebook,
GtkWidget *child,
@ -6668,15 +6668,15 @@ gtk_notebook_mnemonic_activate_switch_page (GtkWidget *child,
/**
* gtk_notebook_insert_page_menu:
* @notebook: a #GtkNotebook
* @child: the #GtkWidget to use as the contents of the page.
* @tab_label: (allow-none): the #GtkWidget to be used as the label for the page,
* or %NULL to use the default label, 'page N'.
* @menu_label: (allow-none): the widget to use as a label for the page-switch
* menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be
* a newly created label with the same text as @tab_label;
* If @tab_label is not a #GtkLabel, @menu_label must be
* specified if the page-switch menu is to be used.
* @child: the #GtkWidget to use as the contents of the page
* @tab_label: (allow-none): the #GtkWidget to be used as the label
* for the page, or %NULL to use the default label, 'page N'
* @menu_label: (allow-none): the widget to use as a label for the
* page-switch menu, if that is enabled. If %NULL, and @tab_label
* is a #GtkLabel or %NULL, then the menu label will be a newly
* created label with the same text as @tab_label; if @tab_label
* is not a #GtkLabel, @menu_label must be specified if the
* page-switch menu is to be used.
* @position: the index (starting at 0) at which to insert the page,
* or -1 to append the page after all other pages.
*
@ -6685,7 +6685,7 @@ gtk_notebook_mnemonic_activate_switch_page (GtkWidget *child,
*
* Return value: the index (starting from 0) of the inserted
* page in the notebook
**/
*/
gint
gtk_notebook_insert_page_menu (GtkNotebook *notebook,
GtkWidget *child,
@ -6707,14 +6707,13 @@ gtk_notebook_insert_page_menu (GtkNotebook *notebook,
/**
* gtk_notebook_remove_page:
* @notebook: a #GtkNotebook.
* @notebook: a #GtkNotebook
* @page_num: the index of a notebook page, starting
* from 0. If -1, the last page will
* be removed.
* from 0. If -1, the last page will be removed.
*
* Removes a page from the notebook given its index
* in the notebook.
**/
*/
void
gtk_notebook_remove_page (GtkNotebook *notebook,
gint page_num)
@ -6750,9 +6749,9 @@ gtk_notebook_remove_page (GtkNotebook *notebook,
* Returns the page number of the current page.
*
* Return value: the index (starting from 0) of the current
* page in the notebook. If the notebook has no pages, then
* -1 will be returned.
**/
* page in the notebook. If the notebook has no pages,
* then -1 will be returned.
*/
gint
gtk_notebook_get_current_page (GtkNotebook *notebook)
{
@ -6772,13 +6771,13 @@ gtk_notebook_get_current_page (GtkNotebook *notebook)
* gtk_notebook_get_nth_page:
* @notebook: a #GtkNotebook
* @page_num: the index of a page in the notebook, or -1
* to get the last page.
* to get the last page
*
* Returns the child widget contained in page number @page_num.
*
* Return value: (transfer none): the child widget, or %NULL if @page_num is
* out of bounds.
**/
* Return value: (transfer none): the child widget, or %NULL
* if @page_num is out of bounds
*/
GtkWidget*
gtk_notebook_get_nth_page (GtkNotebook *notebook,
gint page_num)
@ -6811,10 +6810,10 @@ gtk_notebook_get_nth_page (GtkNotebook *notebook,
*
* Gets the number of pages in a notebook.
*
* Return value: the number of pages in the notebook.
* Return value: the number of pages in the notebook
*
* Since: 2.2
**/
*/
gint
gtk_notebook_get_n_pages (GtkNotebook *notebook)
{
@ -6836,8 +6835,8 @@ gtk_notebook_get_n_pages (GtkNotebook *notebook)
* widget.
*
* Return value: the index of the page containing @child, or
* -1 if @child is not in the notebook.
**/
* -1 if @child is not in the notebook
*/
gint
gtk_notebook_page_num (GtkNotebook *notebook,
GtkWidget *child)
@ -6906,7 +6905,7 @@ gtk_notebook_set_current_page (GtkNotebook *notebook,
*
* Switches to the next page. Nothing happens if the current page is
* the last page.
**/
*/
void
gtk_notebook_next_page (GtkNotebook *notebook)
{
@ -6934,7 +6933,7 @@ gtk_notebook_next_page (GtkNotebook *notebook)
*
* Switches to the previous page. Nothing happens if the current page
* is the first page.
**/
*/
void
gtk_notebook_prev_page (GtkNotebook *notebook)
{
@ -6972,12 +6971,12 @@ gtk_notebook_prev_page (GtkNotebook *notebook)
/**
* gtk_notebook_set_show_border:
* @notebook: a #GtkNotebook
* @show_border: %TRUE if a bevel should be drawn around the notebook.
* @show_border: %TRUE if a bevel should be drawn around the notebook
*
* Sets whether a bevel will be drawn around the notebook pages.
* This only has a visual effect when the tabs are not shown.
* See gtk_notebook_set_show_tabs().
**/
*/
void
gtk_notebook_set_show_border (GtkNotebook *notebook,
gboolean show_border)
@ -7003,11 +7002,11 @@ gtk_notebook_set_show_border (GtkNotebook *notebook,
* gtk_notebook_get_show_border:
* @notebook: a #GtkNotebook
*
* Returns whether a bevel will be drawn around the notebook pages. See
* gtk_notebook_set_show_border().
* Returns whether a bevel will be drawn around the notebook pages.
* See gtk_notebook_set_show_border().
*
* Return value: %TRUE if the bevel is drawn
**/
*/
gboolean
gtk_notebook_get_show_border (GtkNotebook *notebook)
{
@ -7019,10 +7018,10 @@ gtk_notebook_get_show_border (GtkNotebook *notebook)
/**
* gtk_notebook_set_show_tabs:
* @notebook: a #GtkNotebook
* @show_tabs: %TRUE if the tabs should be shown.
* @show_tabs: %TRUE if the tabs should be shown
*
* Sets whether to show the tabs for the notebook or not.
**/
*/
void
gtk_notebook_set_show_tabs (GtkNotebook *notebook,
gboolean show_tabs)
@ -7082,11 +7081,11 @@ gtk_notebook_set_show_tabs (GtkNotebook *notebook,
* gtk_notebook_get_show_tabs:
* @notebook: a #GtkNotebook
*
* Returns whether the tabs of the notebook are shown. See
* gtk_notebook_set_show_tabs().
* Returns whether the tabs of the notebook are shown.
* See gtk_notebook_set_show_tabs().
*
* Return value: %TRUE if the tabs are shown
**/
*/
gboolean
gtk_notebook_get_show_tabs (GtkNotebook *notebook)
{
@ -7098,11 +7097,11 @@ gtk_notebook_get_show_tabs (GtkNotebook *notebook)
/**
* gtk_notebook_set_tab_pos:
* @notebook: a #GtkNotebook.
* @pos: the edge to draw the tabs at.
* @pos: the edge to draw the tabs at
*
* Sets the edge at which the tabs for switching pages in the
* notebook are drawn.
**/
*/
void
gtk_notebook_set_tab_pos (GtkNotebook *notebook,
GtkPositionType pos)
@ -7131,7 +7130,7 @@ gtk_notebook_set_tab_pos (GtkNotebook *notebook,
* notebook are drawn.
*
* Return value: the edge at which the tabs are drawn
**/
*/
GtkPositionType
gtk_notebook_get_tab_pos (GtkNotebook *notebook)
{
@ -7145,9 +7144,9 @@ gtk_notebook_get_tab_pos (GtkNotebook *notebook)
* @notebook: a #GtkNotebook
* @scrollable: %TRUE if scroll arrows should be added
*
* Sets whether the tab label area will have arrows for scrolling if
* there are too many tabs to fit in the area.
**/
* Sets whether the tab label area will have arrows for
* scrolling if there are too many tabs to fit in the area.
*/
void
gtk_notebook_set_scrollable (GtkNotebook *notebook,
gboolean scrollable)
@ -7175,11 +7174,11 @@ gtk_notebook_set_scrollable (GtkNotebook *notebook,
* gtk_notebook_get_scrollable:
* @notebook: a #GtkNotebook
*
* Returns whether the tab label area has arrows for scrolling. See
* gtk_notebook_set_scrollable().
* Returns whether the tab label area has arrows for scrolling.
* See gtk_notebook_set_scrollable().
*
* Return value: %TRUE if arrows for scrolling are present
**/
*/
gboolean
gtk_notebook_get_scrollable (GtkNotebook *notebook)
{
@ -7236,9 +7235,10 @@ gtk_notebook_get_tab_vborder (GtkNotebook *notebook)
* gtk_notebook_popup_enable:
* @notebook: a #GtkNotebook
*
* Enables the popup menu: if the user clicks with the right mouse button on
* the tab labels, a menu with all the pages will be popped up.
**/
* Enables the popup menu: if the user clicks with the right
* mouse button on the tab labels, a menu with all the pages
* will be popped up.
*/
void
gtk_notebook_popup_enable (GtkNotebook *notebook)
{
@ -7271,7 +7271,7 @@ gtk_notebook_popup_enable (GtkNotebook *notebook)
* @notebook: a #GtkNotebook
*
* Disables the popup menu.
**/
*/
void
gtk_notebook_popup_disable (GtkNotebook *notebook)
{
@ -7310,12 +7310,12 @@ gtk_notebook_popup_disable (GtkNotebook *notebook)
* @notebook: a #GtkNotebook
* @child: the page
*
* Returns the tab label widget for the page @child. %NULL is returned
* if @child is not in @notebook or if no tab label has specifically
* been set for @child.
* Returns the tab label widget for the page @child.
* %NULL is returned if @child is not in @notebook or
* if no tab label has specifically been set for @child.
*
* Return value: (transfer none): the tab label
**/
*/
GtkWidget *
gtk_notebook_get_tab_label (GtkNotebook *notebook,
GtkWidget *child)
@ -7339,12 +7339,13 @@ gtk_notebook_get_tab_label (GtkNotebook *notebook,
* gtk_notebook_set_tab_label:
* @notebook: a #GtkNotebook
* @child: the page
* @tab_label: (allow-none): the tab label widget to use, or %NULL for default tab
* label.
* @tab_label: (allow-none): the tab label widget to use, or %NULL
* for default tab label
*
* Changes the tab label for @child. If %NULL is specified
* for @tab_label, then the page will have the label 'page N'.
**/
* Changes the tab label for @child.
* If %NULL is specified for @tab_label, then the page will
* have the label 'page N'.
*/
void
gtk_notebook_set_tab_label (GtkNotebook *notebook,
GtkWidget *child,
@ -7421,7 +7422,7 @@ gtk_notebook_set_tab_label (GtkNotebook *notebook,
*
* Creates a new label and sets it as the tab label for the page
* containing @child.
**/
*/
void
gtk_notebook_set_tab_label_text (GtkNotebook *notebook,
GtkWidget *child,
@ -7446,10 +7447,9 @@ gtk_notebook_set_tab_label_text (GtkNotebook *notebook,
* @child.
*
* Return value: the text of the tab label, or %NULL if the
* tab label widget is not a #GtkLabel. The
* string is owned by the widget and must not
* be freed.
**/
* tab label widget is not a #GtkLabel. The string is owned
* by the widget and must not be freed.
*/
G_CONST_RETURN gchar *
gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
GtkWidget *child)
@ -7477,7 +7477,7 @@ gtk_notebook_get_tab_label_text (GtkNotebook *notebook,
* Return value: (transfer none): the menu label, or %NULL if the
* notebook page does not have a menu label other than the
* default (the tab label).
**/
*/
GtkWidget*
gtk_notebook_get_menu_label (GtkNotebook *notebook,
GtkWidget *child)
@ -7501,10 +7501,10 @@ gtk_notebook_get_menu_label (GtkNotebook *notebook,
* gtk_notebook_set_menu_label:
* @notebook: a #GtkNotebook
* @child: the child widget
* @menu_label: (allow-none): the menu label, or NULL for default
* @menu_label: (allow-none): the menu label, or %NULL for default
*
* Changes the menu label for the page containing @child.
**/
*/
void
gtk_notebook_set_menu_label (GtkNotebook *notebook,
GtkWidget *child,
@ -7555,7 +7555,7 @@ gtk_notebook_set_menu_label (GtkNotebook *notebook,
* @menu_text: the label text
*
* Creates a new label and sets it as the menu label of @child.
**/
*/
void
gtk_notebook_set_menu_label_text (GtkNotebook *notebook,
GtkWidget *child,
@ -7583,11 +7583,10 @@ gtk_notebook_set_menu_label_text (GtkNotebook *notebook,
* @child.
*
* Return value: the text of the tab label, or %NULL if the
* widget does not have a menu label other than
* the default menu label, or the menu label widget
* is not a #GtkLabel. The string is owned by
* the widget and must not be freed.
**/
* widget does not have a menu label other than the default
* menu label, or the menu label widget is not a #GtkLabel.
* The string is owned by the widget and must not be freed.
*/
G_CONST_RETURN gchar *
gtk_notebook_get_menu_label_text (GtkNotebook *notebook,
GtkWidget *child)
@ -7694,7 +7693,7 @@ gtk_notebook_query_tab_label_packing (GtkNotebook *notebook,
* @position. If @position is greater than or equal to the number of
* children in the list or negative, @child will be moved to the end
* of the list.
**/
*/
void
gtk_notebook_reorder_child (GtkNotebook *notebook,
GtkWidget *child,
@ -7798,7 +7797,7 @@ gtk_notebook_set_group_name (GtkNotebook *notebook,
* or %NULL if none is set.
*
* Since: 2.24
**/
*/
const gchar *
gtk_notebook_get_group_name (GtkNotebook *notebook)
{
@ -7817,7 +7816,7 @@ gtk_notebook_get_group_name (GtkNotebook *notebook)
* Return Value: %TRUE if the tab is reorderable.
*
* Since: 2.10
**/
*/
gboolean
gtk_notebook_get_tab_reorderable (GtkNotebook *notebook,
GtkWidget *child)
@ -7838,13 +7837,13 @@ gtk_notebook_get_tab_reorderable (GtkNotebook *notebook,
* gtk_notebook_set_tab_reorderable:
* @notebook: a #GtkNotebook
* @child: a child #GtkWidget
* @reorderable: whether the tab is reorderable or not.
* @reorderable: whether the tab is reorderable or not
*
* Sets whether the notebook tab can be reordered
* via drag and drop or not.
*
* Since: 2.10
**/
*/
void
gtk_notebook_set_tab_reorderable (GtkNotebook *notebook,
GtkWidget *child,
@ -7873,10 +7872,10 @@ gtk_notebook_set_tab_reorderable (GtkNotebook *notebook,
*
* Returns whether the tab contents can be detached from @notebook.
*
* Return Value: TRUE if the tab is detachable.
* Return Value: %TRUE if the tab is detachable.
*
* Since: 2.10
**/
*/
gboolean
gtk_notebook_get_tab_detachable (GtkNotebook *notebook,
GtkWidget *child)
@ -7937,7 +7936,7 @@ gtk_notebook_get_tab_detachable (GtkNotebook *notebook,
* you will have to set your own DnD code to do it.
*
* Since: 2.10
**/
*/
void
gtk_notebook_set_tab_detachable (GtkNotebook *notebook,
GtkWidget *child,