Mass fixing of trivial doc bugs. (#63544, #57007, #64141, #63472, #57108,

* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
        gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
        gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
        (#63544, #57007, #64141, #63472, #57108, #60818, #61562)

        * gtk/tmpl/gtkaccellabel.sgml, gtk/tmpl/gtkcombo.sgml,
        gtk/tmpl/gtkentry.sgml, gtk/tmpl/gtkhscrollbar.sgml,
        gtk/tmpl/gtkvscrollbar.sgml, gtk/tmpl/gtktoolbar.sgml,
        gtk/tmpl/gtkdialog.sgml, gtk/tmpl/gtkstatusbar.sgml:
        Mass fixing of trivial doc bugs. (#55579, #56760, #58769, #55918,
        #64154, #60422, #54697)
This commit is contained in:
Matthias Clasen 2001-11-10 22:06:44 +00:00
parent c9dabae939
commit 79e4b185f6
24 changed files with 198 additions and 151 deletions

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,10 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkiconfactory.c, gtk/gtktextbuffer.c, gtk/gtktreemodel.c,
gtk/gtkwindow.c, gtk/gtknotebook.c, gtk/gtkradiobutton.c,
gtk/gtktextiter.c, gtk/gtkdialog.c: Mass fixing of trivial doc bugs.
(#63544, #57007, #64141, #63472, #57108, #60818, #61562)
2001-11-10 Hans Breuer <hans@breuer.org> 2001-11-10 Hans Breuer <hans@breuer.org>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure * gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure

View File

@ -1,3 +1,12 @@
2001-11-11 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkaccellabel.sgml, gtk/tmpl/gtkcombo.sgml,
gtk/tmpl/gtkentry.sgml, gtk/tmpl/gtkhscrollbar.sgml,
gtk/tmpl/gtkvscrollbar.sgml, gtk/tmpl/gtktoolbar.sgml,
gtk/tmpl/gtkdialog.sgml, gtk/tmpl/gtkstatusbar.sgml:
Mass fixing of trivial doc bugs. (#55579, #56760, #58769, #55918,
#64154, #60422, #54697)
2001-11-10 Matthias Clasen <matthiasc@poet.de> 2001-11-10 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkpaned.sgml: Document gtk_paned_set_gutter_size * gtk/tmpl/gtkpaned.sgml: Document gtk_paned_set_gutter_size

View File

@ -30,7 +30,7 @@ automatically adds a #GtkAccelLabel to the #GtkMenuItem and calls
gtk_accel_label_set_accel_widget() to set it up for you. gtk_accel_label_set_accel_widget() to set it up for you.
</para> </para>
<para> <para>
A #GtkAccelLabel will only display accelerators which have GTK_ACCEL_VISIBLE A #GtkAccelLabel will only display accelerators which have %GTK_ACCEL_VISIBLE
set (see #GtkAccelFlags). set (see #GtkAccelFlags).
A #GtkAccelLabel can display multiple accelerators and even signal names, A #GtkAccelLabel can display multiple accelerators and even signal names,
though it is almost always used to display just one accelerator key. though it is almost always used to display just one accelerator key.
@ -90,7 +90,7 @@ should be accessed using the functions below.
Creates a new #GtkAccelLabel. Creates a new #GtkAccelLabel.
</para> </para>
@string: the label string. Must be non-NULL. @string: the label string. Must be non-%NULL.
@Returns: a new #GtkAccelLabel. @Returns: a new #GtkAccelLabel.
@ -137,7 +137,7 @@ be needed by applications.
</para> </para>
@accel_label: a #GtkAccelLabel. @accel_label: a #GtkAccelLabel.
@Returns: @Returns: the width needed to display the accelerator key(s).
<!-- ##### FUNCTION gtk_accel_label_refetch ##### --> <!-- ##### FUNCTION gtk_accel_label_refetch ##### -->
@ -148,7 +148,7 @@ accelerators are added or removed from the associated widget.
</para> </para>
@accel_label: a #GtkAccelLabel. @accel_label: a #GtkAccelLabel.
@Returns: always returns FALSE. @Returns: always returns %FALSE.
<!-- ##### ARG GtkAccelLabel:accel-object ##### --> <!-- ##### ARG GtkAccelLabel:accel-object ##### -->

View File

@ -137,12 +137,12 @@ the values in the list. If this is set then the user will not be able to
perform any other action until a valid value has been entered. perform any other action until a valid value has been entered.
</para> </para>
<para> <para>
If an empty field is acceptable, the @ok_if_empty parameter should be TRUE. If an empty field is acceptable, the @ok_if_empty parameter should be %TRUE.
</para> </para>
@combo: a #GtkCombo. @combo: a #GtkCombo.
@val: TRUE if the value entered must match one of the values in the list. @val: %TRUE if the value entered must match one of the values in the list.
@ok_if_empty: TRUE if an empty value is considered valid. @ok_if_empty: %TRUE if an empty value is considered valid.
<!-- ##### FUNCTION gtk_combo_set_use_arrows ##### --> <!-- ##### FUNCTION gtk_combo_set_use_arrows ##### -->
@ -152,7 +152,7 @@ the list. This is on by default.
</para> </para>
@combo: a #GtkCombo. @combo: a #GtkCombo.
@val: TRUE if the arrow keys can be used to step through the items in the list. @val: %TRUE if the arrow keys can be used to step through the items in the list.
<!-- ##### FUNCTION gtk_combo_set_use_arrows_always ##### --> <!-- ##### FUNCTION gtk_combo_set_use_arrows_always ##### -->
@ -162,7 +162,8 @@ Specifies if the arrow keys will still work even if the current contents of the
</para> </para>
@combo: a #GtkCombo. @combo: a #GtkCombo.
@val: @val: %TRUE if the arrow keys will still work even if the current contents of
the #GtkEntry field do not match any of the list items.
<!-- ##### FUNCTION gtk_combo_set_case_sensitive ##### --> <!-- ##### FUNCTION gtk_combo_set_case_sensitive ##### -->
@ -177,7 +178,7 @@ worried about differences in case.
</para> </para>
@combo: a #GtkCombo. @combo: a #GtkCombo.
@val: @val: %TRUE if the text in the list items is case sensitive.
<!-- ##### FUNCTION gtk_combo_set_item_string ##### --> <!-- ##### FUNCTION gtk_combo_set_item_string ##### -->
@ -187,7 +188,7 @@ selected. This is needed if the list item is not a simple label.
</para> </para>
@combo: a #GtkCombo. @combo: a #GtkCombo.
@item: a #GtkItem which @item: a #GtkItem.
@item_value: the string to place in the #GtkEntry when @item is selected. @item_value: the string to place in the #GtkEntry when @item is selected.
@ -195,7 +196,7 @@ selected. This is needed if the list item is not a simple label.
<para> <para>
Stops the #GtkCombo widget from showing the popup list when the #GtkEntry Stops the #GtkCombo widget from showing the popup list when the #GtkEntry
emits the "activate" signal, i.e. when the Return key is pressed. emits the "activate" signal, i.e. when the Return key is pressed.
This may be useful if, for example. you want the Return key to close a dialog This may be useful if, for example, you want the Return key to close a dialog
instead. instead.
</para> </para>

View File

@ -169,7 +169,7 @@ Creates a new dialog box. Widgets should not be packed into this #GtkWindow
directly, but into the vbox and action_area, as described above. directly, but into the vbox and action_area, as described above.
</para> </para>
@Returns: a #GtkWidget - the newly created dialog box. @Returns: a new #GtkDialog.
<!-- ##### FUNCTION gtk_dialog_new_with_buttons ##### --> <!-- ##### FUNCTION gtk_dialog_new_with_buttons ##### -->

View File

@ -136,13 +136,17 @@ use gtk_editable_select_region() instead.
<para> <para>
Sets whether the contents of the entry are visible or Sets whether the contents of the entry are visible or
not. When visibility is set to %FALSE, characters not. When visibility is set to %FALSE, characters
are displayed as asterisks (*'s), and will also appear are displayed as the invisible char, and will also appear
that way when the text in the entry widget is copied that way when the text in the entry widget is copied
elsewhere. elsewhere.
</para> </para>
<para>
The default invisible char is the asterisk '*', but it can
be changed with gtk_entry_set_invisible_char().
</para>
@entry: a #GtkEntry. @entry: a #GtkEntry.
@visible: %TRUE if the contents of the entry are displayd @visible: %TRUE if the contents of the entry are displayed
as plaintext. as plaintext.

View File

@ -7,11 +7,11 @@ A horizontal scrollbar
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
The HScrollbar widget is a widget arranged horizontally creating a The #GtkHScrollbar widget is a widget arranged horizontally creating a
scrollbar. See #GtkScrollbar for details on scrollbar. See #GtkScrollbar for details on
scrollbars. #GtkAdjustment pointers may be added to handle the scrollbars. #GtkAdjustment pointers may be added to handle the
adjustment of the scrollbars or it may be left NULL in which case one adjustment of the scrollbar or it may be left %NULL in which case one
will be created you. See #GtkAdjustment for details. will be created for you. See #GtkAdjustment for details.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@ -22,7 +22,7 @@ will be created you. See #GtkAdjustment for details.
<!-- ##### STRUCT GtkHScrollbar ##### --> <!-- ##### STRUCT GtkHScrollbar ##### -->
<para> <para>
The #GtkHScrollbar struct contains private data and should be accessed The #GtkHScrollbar struct contains private data and should be accessed
unsing the functions below. using the functions below.
</para> </para>
@ -31,7 +31,7 @@ unsing the functions below.
Creates a new horizontal scrollbar. Creates a new horizontal scrollbar.
</para> </para>
@adjustment: @adjustment: the #GtkAdjustment to use, or %NULL to create a new adjustment.
@Returns: the new GTKHScrollbar @Returns: the new #GtkHScrollbar.

View File

@ -11,7 +11,7 @@ A #GtkStatusbar is usually placed along the bottom of an application's main
(as is usually the case in a web browser, for example), or may be used to (as is usually the case in a web browser, for example), or may be used to
simply output a message when the status changes, (when an upload is complete simply output a message when the status changes, (when an upload is complete
in an FTP client, for example). in an FTP client, for example).
It may also have a resize grip (a triangular area in the lower left corner) It may also have a resize grip (a triangular area in the lower right corner)
which can be clicked on to resize the window containing the statusbar. which can be clicked on to resize the window containing the statusbar.
</para> </para>
<para> <para>
@ -78,7 +78,7 @@ Pushes a new message onto a statusbar's stack.
@statusbar: a #GtkStatusbar. @statusbar: a #GtkStatusbar.
@context_id: the message's context id, as returned by @context_id: the message's context id, as returned by
gkt_statusbar_get_context_id(). gtk_statusbar_get_context_id().
@text: the message to add to the statusbar. @text: the message to add to the statusbar.
@Returns: the message's new message id for use with gtk_statusbar_remove(). @Returns: the message's new message id for use with gtk_statusbar_remove().
@ -94,7 +94,7 @@ Removes the message at the top of a #GtkStatusBar's stack.
<!-- ##### FUNCTION gtk_statusbar_remove ##### --> <!-- ##### FUNCTION gtk_statusbar_remove ##### -->
<para> <para>
Forces the removal of a message from a statusbar's stack. The exact context_id and message_id must be specified. Forces the removal of a message from a statusbar's stack. The exact @context_id and @message_id must be specified.
</para> </para>
@statusbar: a #GtkStatusBar. @statusbar: a #GtkStatusBar.

View File

@ -15,7 +15,7 @@ Buttons with text and/or images are added with gtk_toolbar_append_item(), gtk_to
Any of #GtkToggleButton, #GtkRadioButton, or an arbitrary widget can be added to the toolbar with gtk_toolbar_append_element(), gtk_toolbar_prepend_element(), and gtk_toolbar_insert_element(). Any of #GtkToggleButton, #GtkRadioButton, or an arbitrary widget can be added to the toolbar with gtk_toolbar_append_element(), gtk_toolbar_prepend_element(), and gtk_toolbar_insert_element().
</para> </para>
<para> <para>
Widgets can be visibily grouped by adding gaps between widgets using gtk_toolbar_append_space(), gtk_toolbar_prepend_space, and gtk_toolbar_insert_space(). Widgets can be visibly grouped by adding gaps between widgets using gtk_toolbar_append_space(), gtk_toolbar_prepend_space(), and gtk_toolbar_insert_space().
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
@ -43,17 +43,15 @@ Widgets can be visibily grouped by adding gaps between widgets using gtk_toolbar
<!-- ##### ENUM GtkToolbarChildType ##### --> <!-- ##### ENUM GtkToolbarChildType ##### -->
<para> <para>
is used to set the type of new elements that are added to a #GtkToolbar. #GtkToolbarChildType is used to set the type of new elements that are added
</para> to a #GtkToolbar.
<para>
SPACE is just a space in the style of the toolbar's GtkToolbarSpaceStyle. BUTTON denotes a #GtkButton. TOGGLEBUTTON denotes a #GtkToggleButton, RADIOBUTTON denotes a #GtkRadioButton, and WIDGET denotes a standard #GtkWidget.
</para> </para>
@GTK_TOOLBAR_CHILD_SPACE: @GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
@GTK_TOOLBAR_CHILD_BUTTON: @GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
@GTK_TOOLBAR_CHILD_TOGGLEBUTTON: @GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
@GTK_TOOLBAR_CHILD_RADIOBUTTON: @GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
@GTK_TOOLBAR_CHILD_WIDGET: @GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
<!-- ##### ENUM GtkToolbarSpaceStyle ##### --> <!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
<para> <para>
@ -75,18 +73,15 @@ SPACE is just a space in the style of the toolbar's GtkToolbarSpaceStyle. BUTTON
<!-- ##### FUNCTION gtk_toolbar_new ##### --> <!-- ##### FUNCTION gtk_toolbar_new ##### -->
<para> <para>
creates a new toolbar. Creates a new toolbar.
</para> </para>
@Returns: the newly created toolbar. @Returns: the newly-created toolbar.
<!-- # Unused Parameters # -->
@orientation: a #GtkOrientation. It determines whether the toolbar appears horizontally or vertically.
@style: a #GtkToolbarStyle. It determines if the toolbar will contain buttons with just labels, just images, or both.
<!-- ##### FUNCTION gtk_toolbar_append_item ##### --> <!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
<para> <para>
adds a new button to the end (right or bottom edges) of the given toolbar. Adds a new button to the end (right or bottom edges) of the given toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -101,7 +96,7 @@ adds a new button to the end (right or bottom edges) of the given toolbar.
<!-- ##### FUNCTION gtk_toolbar_prepend_item ##### --> <!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
<para> <para>
adds a new button to the beginning (top or left edges) of the given toolbar. Adds a new button to the beginning (top or left edges) of the given toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -116,7 +111,7 @@ adds a new button to the beginning (top or left edges) of the given toolbar.
<!-- ##### FUNCTION gtk_toolbar_insert_item ##### --> <!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
<para> <para>
inserts a new item into the toolbar. You must specify the position in the toolbar where it will be inserted. Inserts a new item into the toolbar. You must specify the position in the toolbar where it will be inserted.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -132,7 +127,7 @@ inserts a new item into the toolbar. You must specify the position in the toolba
<!-- ##### FUNCTION gtk_toolbar_append_space ##### --> <!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
<para> <para>
adds a new space to the end of the toolbar. Adds a new space to the end of the toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -140,7 +135,7 @@ adds a new space to the end of the toolbar.
<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### --> <!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
<para> <para>
adds a new space to the beginning of the toolbar. Adds a new space to the beginning of the toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -148,7 +143,7 @@ adds a new space to the beginning of the toolbar.
<!-- ##### FUNCTION gtk_toolbar_insert_space ##### --> <!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
<para> <para>
inserts a new space in the toolbar at the specified position. Inserts a new space in the toolbar at the specified position.
</para> </para>
@toolbar: a #GtkToolbar @toolbar: a #GtkToolbar
@ -157,7 +152,7 @@ inserts a new space in the toolbar at the specified position.
<!-- ##### FUNCTION gtk_toolbar_append_element ##### --> <!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
<para> <para>
adds a new element to the end of a toolbar. Adds a new element to the end of a toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -174,7 +169,7 @@ adds a new element to the end of a toolbar.
<!-- ##### FUNCTION gtk_toolbar_prepend_element ##### --> <!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
<para> <para>
adds a new element to the beginning of a toolbar. Adds a new element to the beginning of a toolbar.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -243,7 +238,7 @@ adds a new element to the beginning of a toolbar.
<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### --> <!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
<para> <para>
sets whether a toolbar should appear horizontally or vertically. Sets whether a toolbar should appear horizontally or vertically.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -252,7 +247,7 @@ sets whether a toolbar should appear horizontally or vertically.
<!-- ##### FUNCTION gtk_toolbar_set_style ##### --> <!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
<para> <para>
alters the view of @toolbar to display either icons only, text only, or both. Alters the view of @toolbar to display either icons only, text only, or both.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@ -261,11 +256,11 @@ alters the view of @toolbar to display either icons only, text only, or both.
<!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### --> <!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
<para> <para>
sets if the tooltips of a toolbar should be active or not. Sets if the tooltips of a toolbar should be active or not.
</para> </para>
@toolbar: a #GtkToolbar. @toolbar: a #GtkToolbar.
@enable: set to 0 to disable the tooltips, or 1 to enable them. @enable: set to %FALSE to disable the tooltips, or %TRUE to enable them.
<!-- ##### FUNCTION gtk_toolbar_insert_stock ##### --> <!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
@ -290,8 +285,6 @@ sets if the tooltips of a toolbar should be active or not.
@toolbar: @toolbar:
@icon_size: @icon_size:
<!-- # Unused Parameters # -->
@stock_size:
<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### --> <!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
@ -357,7 +350,7 @@ sets if the tooltips of a toolbar should be active or not.
<!-- ##### SIGNAL GtkToolbar::orientation-changed ##### --> <!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
<para> <para>
should be used if you wish to perform an action when the orientation of a toolbar is changed. Should be used if you wish to perform an action when the orientation of a toolbar is changed.
</para> </para>
@toolbar: the object which received the signal. @toolbar: the object which received the signal.
@ -365,7 +358,7 @@ should be used if you wish to perform an action when the orientation of a toolba
<!-- ##### SIGNAL GtkToolbar::style-changed ##### --> <!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
<para> <para>
should be used if you wish to perform an action when ever the style of a toolbar is adjusted. For example, this would be a useful signal to connect to if you want to display more items on the toolbar when it is in icon-only mode; each item takes less space on the bar. Should be used if you wish to perform an action when ever the style of a toolbar is adjusted. For example, this would be a useful signal to connect to if you want to display more items on the toolbar when it is in icon-only mode; each item takes less space on the bar.
</para> </para>
@toolbar: the object which received the signal. @toolbar: the object which received the signal.

View File

@ -6,15 +6,15 @@ A vertical scrollbar
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
The VScrollbar widget is a widget arranged vertically creating a scroll bar. See The #GtkVScrollbar widget is a widget arranged vertically creating a scrollbar.
#GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be added to See #GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be
handle the adjustment of the scrollbars or it may be left NULL in which case one added to handle the adjustment of the scrollbar or it may be left %NULL in which
will be created you. See #GtkAdjustment for details. case one will be created for you. See #GtkAdjustment for details.
</para> </para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
#GtkScrollbar, #GtkScrolledWindow
</para> </para>
<!-- ##### STRUCT GtkVScrollbar ##### --> <!-- ##### STRUCT GtkVScrollbar ##### -->
@ -29,7 +29,7 @@ using the functions below.
Creates a new vertical scrollbar. Creates a new vertical scrollbar.
</para> </para>
@adjustment: @adjustment: the #GtkAdjustment to use, or %NULL to create a new adjustment.
@Returns: the new GTKVScrollbar @Returns: the new #GtkVScrollbar

View File

@ -358,29 +358,29 @@ gtk_dialog_new_empty (const gchar *title,
/** /**
* gtk_dialog_new_with_buttons: * gtk_dialog_new_with_buttons:
* @title: Title of the dialog, or NULL * @title: Title of the dialog, or %NULL
* @parent: Transient parent of the dialog, or NULL * @parent: Transient parent of the dialog, or %NULL
* @flags: from #GtkDialogFlags * @flags: from #GtkDialogFlags
* @first_button_text: stock ID or text to go in first button, or NULL * @first_button_text: stock ID or text to go in first button, or %NULL
* @Varargs: response ID for first button, then additional buttons, ending with NULL * @Varargs: response ID for first button, then additional buttons, ending with %NULL
* *
* Creates a new #GtkDialog with title @title (or NULL for the default * Creates a new #GtkDialog with title @title (or %NULL for the default
* title; see gtk_window_set_title()) and transient parent @parent (or * title; see gtk_window_set_title()) and transient parent @parent (or
* NULL for none; see gtk_window_set_transient_for()). The @flags * %NULL for none; see gtk_window_set_transient_for()). The @flags
* argument can be used to make the dialog modal (GTK_DIALOG_MODAL) * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
* and/or to have it destroyed along with its transient parent * and/or to have it destroyed along with its transient parent
* (GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
* text/response ID pairs should be listed, with a NULL pointer ending * text/response ID pairs should be listed, with a %NULL pointer ending
* the list. Button text can be either a stock ID such as * the list. Button text can be either a stock ID such as
* #GTK_STOCK_OK, or some arbitrary text. A response ID can be * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
* any positive number, or one of the values in the #GtkResponseType * any positive number, or one of the values in the #GtkResponseType
* enumeration. If the user clicks one of these dialog buttons, * enumeration. If the user clicks one of these dialog buttons,
* #GtkDialog will emit the "response" signal with the corresponding * #GtkDialog will emit the "response" signal with the corresponding
* response ID. If a #GtkDialog receives the "delete_event" signal, it * response ID. If a #GtkDialog receives the "delete_event" signal, it
* will emit "response" with a response ID of GTK_RESPONSE_DELETE_EVENT. * will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT.
* However, destroying a dialog does not emit the "response" signal; * However, destroying a dialog does not emit the "response" signal;
* so be careful relying on "response" when using * so be careful relying on "response" when using
* the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, * the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
* so the first button in the list will be the leftmost button in the dialog. * so the first button in the list will be the leftmost button in the dialog.
* *
* Here's a simple example: * Here's a simple example:
@ -476,7 +476,6 @@ action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
* the end of the dialog's action area. If you want to add a * the end of the dialog's action area. If you want to add a
* non-activatable widget, simply pack it into the * non-activatable widget, simply pack it into the
* <literal>action_area</literal> field of the #GtkDialog struct. * <literal>action_area</literal> field of the #GtkDialog struct.
*
**/ **/
void void
gtk_dialog_add_action_widget (GtkDialog *dialog, gtk_dialog_add_action_widget (GtkDialog *dialog,
@ -592,10 +591,9 @@ gtk_dialog_add_buttons_valist(GtkDialog *dialog,
* @Varargs: response ID for first button, then more text-response_id pairs * @Varargs: response ID for first button, then more text-response_id pairs
* *
* Adds more buttons, same as calling gtk_dialog_add_button() * Adds more buttons, same as calling gtk_dialog_add_button()
* repeatedly. The variable argument list should be NULL-terminated * repeatedly. The variable argument list should be %NULL-terminated
* as with gtk_dialog_new_with_buttons(). Each button must have both * as with gtk_dialog_new_with_buttons(). Each button must have both
* text and response ID. * text and response ID.
*
**/ **/
void void
gtk_dialog_add_buttons (GtkDialog *dialog, gtk_dialog_add_buttons (GtkDialog *dialog,
@ -622,7 +620,6 @@ gtk_dialog_add_buttons (GtkDialog *dialog,
* Calls gtk_widget_set_sensitive (widget, @setting) for each * Calls gtk_widget_set_sensitive (widget, @setting) for each
* widget in the dialog's action area with the given @response_id. * widget in the dialog's action area with the given @response_id.
* A convenient way to sensitize/desensitize dialog buttons. * A convenient way to sensitize/desensitize dialog buttons.
*
**/ **/
void void
gtk_dialog_set_response_sensitive (GtkDialog *dialog, gtk_dialog_set_response_sensitive (GtkDialog *dialog,
@ -660,7 +657,6 @@ gtk_dialog_set_response_sensitive (GtkDialog *dialog,
* Sets the last widget in the dialog's action area with the given @response_id * Sets the last widget in the dialog's action area with the given @response_id
* as the default widget for the dialog. Pressing "Enter" normally activates * as the default widget for the dialog. Pressing "Enter" normally activates
* the default widget. * the default widget.
*
**/ **/
void void
gtk_dialog_set_default_response (GtkDialog *dialog, gtk_dialog_set_default_response (GtkDialog *dialog,
@ -701,7 +697,6 @@ gtk_dialog_set_default_response (GtkDialog *dialog,
* *
* Sets whether the dialog has a separator above the buttons. * Sets whether the dialog has a separator above the buttons.
* %TRUE by default. * %TRUE by default.
*
**/ **/
void void
gtk_dialog_set_has_separator (GtkDialog *dialog, gtk_dialog_set_has_separator (GtkDialog *dialog,
@ -823,7 +818,7 @@ run_delete_handler (GtkDialog *dialog,
* *
* Blocks in a recursive main loop until the @dialog either emits the * Blocks in a recursive main loop until the @dialog either emits the
* response signal, or is destroyed. If the dialog is destroyed, * response signal, or is destroyed. If the dialog is destroyed,
* gtk_dialog_run() returns GTK_RESPONSE_NONE. Otherwise, it returns * gtk_dialog_run() returns #GTK_RESPONSE_NONE. Otherwise, it returns
* the response ID from the "response" signal emission. Before * the response ID from the "response" signal emission. Before
* entering the recursive main loop, gtk_dialog_run() calls * entering the recursive main loop, gtk_dialog_run() calls
* gtk_widget_show() on the dialog for you. Note that you still * gtk_widget_show() on the dialog for you. Note that you still
@ -832,7 +827,7 @@ run_delete_handler (GtkDialog *dialog,
* During gtk_dialog_run(), the default behavior of "delete_event" is * During gtk_dialog_run(), the default behavior of "delete_event" is
* disabled; if the dialog receives "delete_event", it will not be * disabled; if the dialog receives "delete_event", it will not be
* destroyed as windows usually are, and gtk_dialog_run() will return * destroyed as windows usually are, and gtk_dialog_run() will return
* GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
* modal. You can force gtk_dialog_run() to return at any time by * modal. You can force gtk_dialog_run() to return at any time by
* calling gtk_dialog_response() to emit the "response" * calling gtk_dialog_response() to emit the "response"
* signal. Destroying the dialog during gtk_dialog_run() is a very bad * signal. Destroying the dialog during gtk_dialog_run() is a very bad

View File

@ -913,11 +913,11 @@ gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
/** /**
* gtk_icon_set_ref: * gtk_icon_set_ref:
* @icon_set: a #GtkIconSet * @icon_set: a #GtkIconSet.
* *
* Increments the reference count on @icon_set * Increments the reference count on @icon_set.
* *
* Return value: @icon_set is returned * Return value: @icon_set.
**/ **/
GtkIconSet* GtkIconSet*
gtk_icon_set_ref (GtkIconSet *icon_set) gtk_icon_set_ref (GtkIconSet *icon_set)

View File

@ -4184,8 +4184,8 @@ gtk_notebook_get_show_tabs (GtkNotebook *notebook)
/** /**
* gtk_notebook_set_tab_pos: * gtk_notebook_set_tab_pos:
* @notebook: * @notebook: a #GtkNotebook.
* @pos: * @pos: the edge to draw the tabs at.
* *
* Sets the edge at which the tabs for switching pages in the * Sets the edge at which the tabs for switching pages in the
* notebook are drawn. * notebook are drawn.
@ -4253,7 +4253,7 @@ gtk_notebook_set_homogeneous_tabs (GtkNotebook *notebook,
* Sets the width the border around the tab labels * Sets the width the border around the tab labels
* in a notebook. This is equivalent to calling * in a notebook. This is equivalent to calling
* gtk_notebook_set_tab_hborder (@notebook, @border_width) followed * gtk_notebook_set_tab_hborder (@notebook, @border_width) followed
* by gtk_noteobok_set_tab_vborder (@notebook, @border_width). * by gtk_notebook_set_tab_vborder (@notebook, @border_width).
**/ **/
void void
gtk_notebook_set_tab_border (GtkNotebook *notebook, gtk_notebook_set_tab_border (GtkNotebook *notebook,
@ -4323,7 +4323,6 @@ gtk_notebook_set_tab_vborder (GtkNotebook *notebook,
* *
* Sets whether the tab label area will have arrows for scrolling if * Sets whether the tab label area will have arrows for scrolling if
* there are too many tabs to fit in the area. * there are too many tabs to fit in the area.
**/ **/
void void
gtk_notebook_set_scrollable (GtkNotebook *notebook, gtk_notebook_set_scrollable (GtkNotebook *notebook,

View File

@ -238,9 +238,10 @@ gtk_radio_button_new_with_label (GSList *group,
* mnemonic character * mnemonic character
* @returns: a new #GtkRadioButton * @returns: a new #GtkRadioButton
* *
* Creates a new #GtkRadioButton containing a label. The label * Creates a new #GtkRadioButton containing a label, adding it to the same
* will be created using gtk_label_new_with_mnemonic(), so underscores * group as @group. The label will be created using
* in @label indicate the mnemonic for the button. * gtk_label_new_with_mnemonic(), so underscores in @label indicate the
* mnemonic for the button.
**/ **/
GtkWidget* GtkWidget*
gtk_radio_button_new_with_mnemonic (GSList *group, gtk_radio_button_new_with_mnemonic (GSList *group,

View File

@ -1786,7 +1786,7 @@ gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer,
* *
* Returns the mark that represents the cursor (insertion point). * Returns the mark that represents the cursor (insertion point).
* Equivalent to calling gtk_text_buffer_get_mark () to get the mark * Equivalent to calling gtk_text_buffer_get_mark () to get the mark
* name "insert," but very slightly more efficient, and involves less * named "insert", but very slightly more efficient, and involves less
* typing. * typing.
* *
* Return value: insertion point mark * Return value: insertion point mark
@ -1805,8 +1805,8 @@ gtk_text_buffer_get_insert (GtkTextBuffer *buffer)
* @buffer: a #GtkTextBuffer * @buffer: a #GtkTextBuffer
* *
* Returns the mark that represents the selection bound. Equivalent * Returns the mark that represents the selection bound. Equivalent
* to calling gtk_text_buffer_get_mark () to get the mark name * to calling gtk_text_buffer_get_mark () to get the mark named
* "selection_bound," but very slightly more efficient, and involves * "selection_bound", but very slightly more efficient, and involves
* less typing. * less typing.
* *
* The currently-selected text in @buffer is the region between the * The currently-selected text in @buffer is the region between the
@ -1887,7 +1887,7 @@ gtk_text_buffer_place_cursor (GtkTextBuffer *buffer,
* *
* *
* Creates a tag and adds it to the tag table for @buffer. * Creates a tag and adds it to the tag table for @buffer.
* Equivalent to calling gtk_text_tag_new () and then adding the * Equivalent to calling gtk_text_tag_ne () and then adding the
* tag to the buffer's tag table. The returned tag is owned by * tag to the buffer's tag table. The returned tag is owned by
* the buffer's tag table, so the ref count will be equal to one. * the buffer's tag table, so the ref count will be equal to one.
* *

View File

@ -397,7 +397,7 @@ check_invariants (const GtkTextIter *iter)
* gtk_text_iter_get_buffer: * gtk_text_iter_get_buffer:
* @iter: an iterator * @iter: an iterator
* *
* Return the #GtkTextBuffer this iterator is associated with * Returns the #GtkTextBuffer this iterator is associated with.
* *
* Return value: the buffer * Return value: the buffer
**/ **/
@ -422,7 +422,7 @@ gtk_text_iter_get_buffer (const GtkTextIter *iter)
* gtk_text_iter_copy: * gtk_text_iter_copy:
* @iter: an iterator * @iter: an iterator
* *
* Create a dynamically-allocated copy of an iterator. This function * Creates a dynamically-allocated copy of an iterator. This function
* is not useful in applications, because iterators can be copied with a * is not useful in applications, because iterators can be copied with a
* simple assignment (<literal>GtkTextIter i = j;</literal>). The * simple assignment (<literal>GtkTextIter i = j;</literal>). The
* function is used by language bindings. * function is used by language bindings.
@ -451,7 +451,6 @@ gtk_text_iter_copy (const GtkTextIter *iter)
* is intended for use in language bindings, and is not * is intended for use in language bindings, and is not
* especially useful for applications, because iterators can * especially useful for applications, because iterators can
* simply be allocated on the stack. * simply be allocated on the stack.
*
**/ **/
void void
gtk_text_iter_free (GtkTextIter *iter) gtk_text_iter_free (GtkTextIter *iter)
@ -982,7 +981,7 @@ gtk_text_iter_get_visible_text (const GtkTextIter *start,
* *
* If the location pointed to by @iter contains a pixbuf, the pixbuf * If the location pointed to by @iter contains a pixbuf, the pixbuf
* is returned (with no new reference count added). Otherwise, * is returned (with no new reference count added). Otherwise,
* NULL is returned. * %NULL is returned.
* *
* Return value: the pixbuf at @iter * Return value: the pixbuf at @iter
**/ **/
@ -1012,7 +1011,7 @@ gtk_text_iter_get_pixbuf (const GtkTextIter *iter)
* *
* If the location pointed to by @iter contains a child anchor, the * If the location pointed to by @iter contains a child anchor, the
* anchor is returned (with no new reference count added). Otherwise, * anchor is returned (with no new reference count added). Otherwise,
* NULL is returned. * %NULL is returned.
* *
* Return value: the anchor at @iter * Return value: the anchor at @iter
**/ **/
@ -1083,10 +1082,10 @@ gtk_text_iter_get_marks (const GtkTextIter *iter)
/** /**
* gtk_text_iter_get_toggled_tags: * gtk_text_iter_get_toggled_tags:
* @iter: an iterator * @iter: an iterator
* @toggled_on: TRUE to get toggled-on tags * @toggled_on: %TRUE to get toggled-on tags
* *
* Returns a list of #GtkTextTag that are toggled on or off at this * Returns a list of #GtkTextTag that are toggled on or off at this
* point. (If @toggled_on is TRUE, the list contains tags that are * point. (If @toggled_on is %TRUE, the list contains tags that are
* toggled on.) If a tag is toggled on at @iter, then some non-empty * toggled on.) If a tag is toggled on at @iter, then some non-empty
* range of characters following @iter has that tag applied to it. If * range of characters following @iter has that tag applied to it. If
* a tag is toggled off, then some non-empty range following @iter * a tag is toggled off, then some non-empty range following @iter
@ -1141,11 +1140,11 @@ gtk_text_iter_get_toggled_tags (const GtkTextIter *iter,
/** /**
* gtk_text_iter_begins_tag: * gtk_text_iter_begins_tag:
* @iter: an iterator * @iter: an iterator
* @tag: a #GtkTextTag, or NULL * @tag: a #GtkTextTag, or %NULL
* *
* Returns TRUE if @tag is toggled on at exactly this point. If @tag * Returns %TRUE if @tag is toggled on at exactly this point. If @tag
* is NULL, returns TRUE if any tag is toggled on at this point. Note * is %NULL, returns %TRUE if any tag is toggled on at this point. Note
* that the gtk_text_iter_begins_tag () returns TRUE if @iter is the * that the gtk_text_iter_begins_tag () returns %TRUE if @iter is the
* <emphasis>start</emphasis> of the tagged range; * <emphasis>start</emphasis> of the tagged range;
* gtk_text_iter_has_tag () tells you whether an iterator is * gtk_text_iter_has_tag () tells you whether an iterator is
* <emphasis>within</emphasis> a tagged range. * <emphasis>within</emphasis> a tagged range.
@ -1187,11 +1186,11 @@ gtk_text_iter_begins_tag (const GtkTextIter *iter,
/** /**
* gtk_text_iter_ends_tag: * gtk_text_iter_ends_tag:
* @iter: an iterator * @iter: an iterator
* @tag: a #GtkTextTag, or NULL * @tag: a #GtkTextTag, or %NULL
* *
* Returns TRUE if @tag is toggled off at exactly this point. If @tag * Returns %TRUE if @tag is toggled off at exactly this point. If @tag
* is NULL, returns TRUE if any tag is toggled off at this point. Note * is %NULL, returns %TRUE if any tag is toggled off at this point. Note
* that the gtk_text_iter_ends_tag () returns TRUE if @iter is the * that the gtk_text_iter_ends_tag () returns %TRUE if @iter is the
* <emphasis>end</emphasis> of the tagged range; * <emphasis>end</emphasis> of the tagged range;
* gtk_text_iter_has_tag () tells you whether an iterator is * gtk_text_iter_has_tag () tells you whether an iterator is
* <emphasis>within</emphasis> a tagged range. * <emphasis>within</emphasis> a tagged range.
@ -1234,7 +1233,7 @@ gtk_text_iter_ends_tag (const GtkTextIter *iter,
/** /**
* gtk_text_iter_toggles_tag: * gtk_text_iter_toggles_tag:
* @iter: an iterator * @iter: an iterator
* @tag: a #GtkTextTag, or NULL * @tag: a #GtkTextTag, or %NULL
* *
* This is equivalent to (gtk_text_iter_begins_tag () || * This is equivalent to (gtk_text_iter_begins_tag () ||
* gtk_text_iter_ends_tag ()), i.e. it tells you whether a range with * gtk_text_iter_ends_tag ()), i.e. it tells you whether a range with
@ -1278,7 +1277,7 @@ gtk_text_iter_toggles_tag (const GtkTextIter *iter,
* @iter: an iterator * @iter: an iterator
* @tag: a #GtkTextTag * @tag: a #GtkTextTag
* *
* Returns TRUE if @iter is within a range tagged with @tag. * Returns %TRUE if @iter is within a range tagged with @tag.
* *
* Return value: whether @iter is tagged with @tag * Return value: whether @iter is tagged with @tag
**/ **/
@ -1449,7 +1448,7 @@ gtk_text_iter_can_insert (const GtkTextIter *iter,
* *
* A convenience wrapper around gtk_text_iter_get_attributes (), * A convenience wrapper around gtk_text_iter_get_attributes (),
* which returns the language in effect at @iter. If no tags affecting * which returns the language in effect at @iter. If no tags affecting
* language * apply to @iter, the return value is identical to that of * language apply to @iter, the return value is identical to that of
* gtk_get_default_language (). * gtk_get_default_language ().
* *
* Return value: language in effect at @iter * Return value: language in effect at @iter
@ -1475,7 +1474,7 @@ gtk_text_iter_get_language (const GtkTextIter *iter)
* gtk_text_iter_starts_line: * gtk_text_iter_starts_line:
* @iter: an iterator * @iter: an iterator
* *
* Returns TRUE if @iter begins a paragraph, * Returns %TRUE if @iter begins a paragraph,
* i.e. if gtk_text_iter_get_line_offset () would return 0. * i.e. if gtk_text_iter_get_line_offset () would return 0.
* However this function is potentially more efficient than * However this function is potentially more efficient than
* gtk_text_iter_get_line_offset () because it doesn't have to compute * gtk_text_iter_get_line_offset () because it doesn't have to compute
@ -1512,7 +1511,7 @@ gtk_text_iter_starts_line (const GtkTextIter *iter)
* gtk_text_iter_ends_line: * gtk_text_iter_ends_line:
* @iter: an iterator * @iter: an iterator
* *
* Returns TRUE if @iter points to the start of the paragraph delimiter * Returns %TRUE if @iter points to the start of the paragraph delimiter
* characters for a line (delimiters will be either a newline, a * characters for a line (delimiters will be either a newline, a
* carriage return, a carriage return followed by a newline, or a * carriage return, a carriage return followed by a newline, or a
* Unicode paragraph separator character). Note that an iterator pointing * Unicode paragraph separator character). Note that an iterator pointing
@ -1561,7 +1560,7 @@ gtk_text_iter_ends_line (const GtkTextIter *iter)
* gtk_text_iter_is_end: * gtk_text_iter_is_end:
* @iter: an iterator * @iter: an iterator
* *
* Returns TRUE if @iter is the end iterator, i.e. one past the last * Returns %TRUE if @iter is the end iterator, i.e. one past the last
* dereferenceable iterator in the buffer. gtk_text_iter_is_end () is * dereferenceable iterator in the buffer. gtk_text_iter_is_end () is
* the most efficient way to check whether an iterator is the end * the most efficient way to check whether an iterator is the end
* iterator. * iterator.
@ -1601,7 +1600,7 @@ gtk_text_iter_is_end (const GtkTextIter *iter)
* gtk_text_iter_is_start: * gtk_text_iter_is_start:
* @iter: an iterator * @iter: an iterator
* *
* Returns TRUE if @iter is the first iterator in the buffer, that is * Returns %TRUE if @iter is the first iterator in the buffer, that is
* if @iter has a character offset of 0. * if @iter has a character offset of 0.
* *
* Return value: whether @iter is the first in the buffer * Return value: whether @iter is the first in the buffer
@ -2181,10 +2180,10 @@ _gtk_text_iter_backward_indexable_segment (GtkTextIter *iter)
* gtk_text_iter_forward_char () may actually move onto an image instead * gtk_text_iter_forward_char () may actually move onto an image instead
* of a character, if you have images in your buffer. If @iter is the * of a character, if you have images in your buffer. If @iter is the
* end iterator or one character before it, @iter will now point at * end iterator or one character before it, @iter will now point at
* the end iterator, and gtk_text_iter_forward_char () returns FALSE for * the end iterator, and gtk_text_iter_forward_char () returns %FALSE for
* convenience when writing loops. * convenience when writing loops.
* *
* Return value: whether the new position is the end iterator * Return value: whether @iter moved and is dereferenceable
**/ **/
gboolean gboolean
gtk_text_iter_forward_char (GtkTextIter *iter) gtk_text_iter_forward_char (GtkTextIter *iter)
@ -2208,9 +2207,9 @@ gtk_text_iter_forward_char (GtkTextIter *iter)
* gtk_text_iter_backward_char: * gtk_text_iter_backward_char:
* @iter: an iterator * @iter: an iterator
* *
* Moves backward by one character offset. Returns TRUE if movement * Moves backward by one character offset. Returns %TRUE if movement
* was possible; if @iter was the first in the buffer (character * was possible; if @iter was the first in the buffer (character
* offset 0), gtk_text_iter_backward_char () returns FALSE for convenience when * offset 0), gtk_text_iter_backward_char () returns %FALSE for convenience when
* writing loops. * writing loops.
* *
* Return value: whether movement was possible * Return value: whether movement was possible
@ -2250,7 +2249,7 @@ gtk_text_iter_backward_char (GtkTextIter *iter)
* buffer). The return value indicates whether the new position of * buffer). The return value indicates whether the new position of
* @iter is different from its original position, and dereferenceable * @iter is different from its original position, and dereferenceable
* (the last iterator in the buffer is not dereferenceable). If @count * (the last iterator in the buffer is not dereferenceable). If @count
* is 0, the function does nothing and returns FALSE. * is 0, the function does nothing and returns %FALSE.
* *
* Return value: whether @iter moved and is dereferenceable * Return value: whether @iter moved and is dereferenceable
**/ **/
@ -2320,8 +2319,8 @@ gtk_text_iter_forward_chars (GtkTextIter *iter, gint count)
* past the start or end of the buffer, moves to the start or end of * past the start or end of the buffer, moves to the start or end of
* the buffer). The return value indicates whether the iterator moved * the buffer). The return value indicates whether the iterator moved
* onto a dereferenceable position; if the iterator didn't move, or * onto a dereferenceable position; if the iterator didn't move, or
* moved onto the end iterator, then FALSE is returned. If @count is 0, * moved onto the end iterator, then %FALSE is returned. If @count is 0,
* the function does nothing and returns FALSE. * the function does nothing and returns %FALSE.
* *
* Return value: whether @iter moved and is dereferenceable * Return value: whether @iter moved and is dereferenceable
* *
@ -2475,8 +2474,8 @@ gtk_text_iter_backward_text_chars (GtkTextIter *iter,
* gtk_text_iter_forward_line: * gtk_text_iter_forward_line:
* @iter: an iterator * @iter: an iterator
* *
* Moves @iter to the start of the next line. Returns TRUE if there * Moves @iter to the start of the next line. Returns %TRUE if there
* was a next line to move to, and FALSE if @iter was simply moved to * was a next line to move to, and %FALSE if @iter was simply moved to
* the end of the buffer and is now not dereferenceable, or if @iter was * the end of the buffer and is now not dereferenceable, or if @iter was
* already at the end of the buffer. * already at the end of the buffer.
* *
@ -2524,11 +2523,11 @@ gtk_text_iter_forward_line (GtkTextIter *iter)
* gtk_text_iter_backward_line: * gtk_text_iter_backward_line:
* @iter: an iterator * @iter: an iterator
* *
* Moves @iter to the start of the previous line. Returns TRUE if * Moves @iter to the start of the previous line. Returns %TRUE if
* @iter could be moved; i.e. if @iter was at character offset 0, this * @iter could be moved; i.e. if @iter was at character offset 0, this
* function returns FALSE. Therefore if @iter was already on line 0, * function returns %FALSE. Therefore if @iter was already on line 0,
* but not at the start of the line, @iter is snapped to the start of * but not at the start of the line, @iter is snapped to the start of
* the line and the function returns TRUE. (Note that this implies that * the line and the function returns %TRUE. (Note that this implies that
* in a loop calling this function, the line number may not change on * in a loop calling this function, the line number may not change on
* every iteration, if your first iteration is on line 0.) * every iteration, if your first iteration is on line 0.)
* *
@ -2605,8 +2604,8 @@ gtk_text_iter_backward_line (GtkTextIter *iter)
* past the start or end of the buffer, moves to the start or end of * past the start or end of the buffer, moves to the start or end of
* the buffer). The return value indicates whether the iterator moved * the buffer). The return value indicates whether the iterator moved
* onto a dereferenceable position; if the iterator didn't move, or * onto a dereferenceable position; if the iterator didn't move, or
* moved onto the end iterator, then FALSE is returned. If @count is 0, * moved onto the end iterator, then %FALSE is returned. If @count is 0,
* the function does nothing and returns FALSE. If @count is negative, * the function does nothing and returns %FALSE. If @count is negative,
* moves backward by 0 - @count lines. * moves backward by 0 - @count lines.
* *
* Return value: whether @iter moved and is dereferenceable * Return value: whether @iter moved and is dereferenceable
@ -2656,8 +2655,8 @@ gtk_text_iter_forward_lines (GtkTextIter *iter, gint count)
* past the start or end of the buffer, moves to the start or end of * past the start or end of the buffer, moves to the start or end of
* the buffer). The return value indicates whether the iterator moved * the buffer). The return value indicates whether the iterator moved
* onto a dereferenceable position; if the iterator didn't move, or * onto a dereferenceable position; if the iterator didn't move, or
* moved onto the end iterator, then FALSE is returned. If @count is 0, * moved onto the end iterator, then %FALSE is returned. If @count is 0,
* the function does nothing and returns FALSE. If @count is negative, * the function does nothing and returns %FALSE. If @count is negative,
* moves forward by 0 - @count lines. * moves forward by 0 - @count lines.
* *
* Return value: whether @iter moved and is dereferenceable * Return value: whether @iter moved and is dereferenceable
@ -3688,7 +3687,6 @@ gtk_text_iter_set_line (GtkTextIter *iter,
* *
* Sets @iter to point to @char_offset. @char_offset counts from the start * Sets @iter to point to @char_offset. @char_offset counts from the start
* of the entire text buffer, starting with 0. * of the entire text buffer, starting with 0.
*
**/ **/
void void
gtk_text_iter_set_offset (GtkTextIter *iter, gtk_text_iter_set_offset (GtkTextIter *iter,
@ -3732,7 +3730,6 @@ gtk_text_iter_set_offset (GtkTextIter *iter,
* Moves @iter forward to the "end iterator," which points one past the last * Moves @iter forward to the "end iterator," which points one past the last
* valid character in the buffer. gtk_text_iter_get_char() called on the * valid character in the buffer. gtk_text_iter_get_char() called on the
* end iterator returns 0, which is convenient for writing loops. * end iterator returns 0, which is convenient for writing loops.
*
**/ **/
void void
gtk_text_iter_forward_to_end (GtkTextIter *iter) gtk_text_iter_forward_to_end (GtkTextIter *iter)
@ -3829,12 +3826,12 @@ gtk_text_iter_forward_to_line_end (GtkTextIter *iter)
/** /**
* gtk_text_iter_forward_to_tag_toggle: * gtk_text_iter_forward_to_tag_toggle:
* @iter: a #GtkTextIter * @iter: a #GtkTextIter
* @tag: a #GtkTextTag, or NULL * @tag: a #GtkTextTag, or %NULL
* *
* Moves forward to the next toggle (on or off) of the * Moves forward to the next toggle (on or off) of the
* #GtkTextTag @tag, or to the next toggle of any tag if * #GtkTextTag @tag, or to the next toggle of any tag if
* @tag is NULL. If no matching tag toggles are found, * @tag is %NULL. If no matching tag toggles are found,
* returns FALSE, otherwise TRUE. Does not return toggles * returns %FALSE, otherwise %TRUE. Does not return toggles
* located at @iter, only toggles after @iter. Sets @iter to * located at @iter, only toggles after @iter. Sets @iter to
* the location of the toggle, or to the end of the buffer * the location of the toggle, or to the end of the buffer
* if no toggle is found. * if no toggle is found.
@ -3911,12 +3908,12 @@ gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter,
/** /**
* gtk_text_iter_backward_to_tag_toggle: * gtk_text_iter_backward_to_tag_toggle:
* @iter: a #GtkTextIter * @iter: a #GtkTextIter
* @tag: a #GtkTextTag, or NULL * @tag: a #GtkTextTag, or %NULL
* *
* Moves backward to the next toggle (on or off) of the * Moves backward to the next toggle (on or off) of the
* #GtkTextTag @tag, or to the next toggle of any tag if * #GtkTextTag @tag, or to the next toggle of any tag if
* @tag is NULL. If no matching tag toggles are found, * @tag is %NULL. If no matching tag toggles are found,
* returns FALSE, otherwise TRUE. Does not return toggles * returns %FALSE, otherwise %TRUE. Does not return toggles
* located at @iter, only toggles before @iter. Sets @iter * located at @iter, only toggles before @iter. Sets @iter
* to the location of the toggle, or the start of the buffer * to the location of the toggle, or the start of the buffer
* if no toggle is found. * if no toggle is found.

View File

@ -397,7 +397,7 @@ gtk_tree_path_compare (const GtkTreePath *a,
* @path: a #GtkTreePath * @path: a #GtkTreePath
* @descendant: another #GtkTreePath * @descendant: another #GtkTreePath
* *
* Returns %TRUE is @descendant is a descendant of @path. * Returns %TRUE if @descendant is a descendant of @path.
* *
* Return value: %TRUE if @descendant is contained inside @path * Return value: %TRUE if @descendant is contained inside @path
**/ **/

View File

@ -5107,11 +5107,10 @@ gtk_window_group_get_type (void)
/** /**
* gtk_window_group_new: * gtk_window_group_new:
* *
* Create a new #GtkWindowGroup object. Grabs added with * Creates a new #GtkWindowGroup object. Grabs added with
* gtk_window_grab_add() only affect windows within the * gtk_grab_add() only affect windows within the same #GtkWindowGroup.
* same #GtkWindowGroup
* *
* Return value: * Return value: a new #GtkWindowGroup.
**/ **/
GtkWindowGroup * GtkWindowGroup *
gtk_window_group_new (void) gtk_window_group_new (void)
@ -5147,7 +5146,7 @@ window_group_cleanup_grabs (GtkWindowGroup *group,
* @window_group: a #GtkWindowGroup * @window_group: a #GtkWindowGroup
* @window: the #GtkWindow to add * @window: the #GtkWindow to add
* *
* Add a window to a #GtkWindowGroup. * Adds a window to a #GtkWindowGroup.
**/ **/
void void
gtk_window_group_add_window (GtkWindowGroup *window_group, gtk_window_group_add_window (GtkWindowGroup *window_group,