Commit 79e4b185 authored by Matthias Clasen's avatar Matthias Clasen

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)
parent c9dabae9
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gdk/win32/gdkevents-win32.c (gdk_event_translate) : make sure
......
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>
* gtk/tmpl/gtkpaned.sgml: Document gtk_paned_set_gutter_size
......
......@@ -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.
</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).
A #GtkAccelLabel can display multiple accelerators and even signal names,
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.
</para>
@string: the label string. Must be non-NULL.
@string: the label string. Must be non-%NULL.
@Returns: a new #GtkAccelLabel.
......@@ -117,7 +117,7 @@ Creates a new #GtkAccelLabel.
</para>
@accel_label:
@accel_label:
<!-- ##### MACRO gtk_accel_label_set_accel_widget ##### -->
......@@ -137,7 +137,7 @@ be needed by applications.
</para>
@accel_label: a #GtkAccelLabel.
@Returns:
@Returns: the width needed to display the accelerator key(s).
<!-- ##### FUNCTION gtk_accel_label_refetch ##### -->
......@@ -148,7 +148,7 @@ accelerators are added or removed from the associated widget.
</para>
@accel_label: a #GtkAccelLabel.
@Returns: always returns FALSE.
@Returns: always returns %FALSE.
<!-- ##### ARG GtkAccelLabel:accel-object ##### -->
......
......@@ -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.
</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>
@combo: a #GtkCombo.
@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.
@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.
<!-- ##### FUNCTION gtk_combo_set_use_arrows ##### -->
......@@ -152,7 +152,7 @@ the list. This is on by default.
</para>
@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 ##### -->
......@@ -162,7 +162,8 @@ Specifies if the arrow keys will still work even if the current contents of the
</para>
@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 ##### -->
......@@ -177,7 +178,7 @@ worried about differences in case.
</para>
@combo: a #GtkCombo.
@val:
@val: %TRUE if the text in the list items is case sensitive.
<!-- ##### FUNCTION gtk_combo_set_item_string ##### -->
......@@ -187,7 +188,7 @@ selected. This is needed if the list item is not a simple label.
</para>
@combo: a #GtkCombo.
@item: a #GtkItem which
@item: a #GtkItem.
@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>
Stops the #GtkCombo widget from showing the popup list when the #GtkEntry
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.
</para>
......
......@@ -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.
</para>
@Returns: a #GtkWidget - the newly created dialog box.
@Returns: a new #GtkDialog.
<!-- ##### FUNCTION gtk_dialog_new_with_buttons ##### -->
......
......@@ -136,13 +136,17 @@ use gtk_editable_select_region() instead.
<para>
Sets whether the contents of the entry are visible or
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
elsewhere.
</para>
<para>
The default invisible char is the asterisk '*', but it can
be changed with gtk_entry_set_invisible_char().
</para>
@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.
......
......@@ -7,11 +7,11 @@ A horizontal scrollbar
<!-- ##### SECTION Long_Description ##### -->
<para>
The HScrollbar widget is a widget arranged horizontally creating a
scroll bar. See #GtkScrollbar for details on
The #GtkHScrollbar widget is a widget arranged horizontally creating a
scrollbar. See #GtkScrollbar for details on
scrollbars. #GtkAdjustment pointers may be added to handle the
adjustment of the scrollbars or it may be left NULL in which case one
will be created you. See #GtkAdjustment for details.
adjustment of the scrollbar or it may be left %NULL in which case one
will be created for you. See #GtkAdjustment for details.
</para>
<!-- ##### SECTION See_Also ##### -->
......@@ -22,7 +22,7 @@ will be created you. See #GtkAdjustment for details.
<!-- ##### STRUCT GtkHScrollbar ##### -->
<para>
The #GtkHScrollbar struct contains private data and should be accessed
unsing the functions below.
using the functions below.
</para>
......@@ -31,7 +31,7 @@ unsing the functions below.
Creates a new horizontal scrollbar.
</para>
@adjustment:
@Returns: the new GTKHScrollbar
@adjustment: the #GtkAdjustment to use, or %NULL to create a new adjustment.
@Returns: the new #GtkHScrollbar.
......@@ -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
simply output a message when the status changes, (when an upload is complete
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.
</para>
<para>
......@@ -78,7 +78,7 @@ Pushes a new message onto a statusbar's stack.
@statusbar: a #GtkStatusbar.
@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.
@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 ##### -->
<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>
@statusbar: a #GtkStatusBar.
......
......@@ -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().
</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>
<!-- ##### SECTION See_Also ##### -->
......@@ -43,17 +43,15 @@ Widgets can be visibily grouped by adding gaps between widgets using gtk_toolbar
<!-- ##### ENUM GtkToolbarChildType ##### -->
<para>
is used to set the type of new elements that are added to a #GtkToolbar.
</para>
<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.
#GtkToolbarChildType is used to set the type of new elements that are added
to a #GtkToolbar.
</para>
@GTK_TOOLBAR_CHILD_SPACE:
@GTK_TOOLBAR_CHILD_BUTTON:
@GTK_TOOLBAR_CHILD_TOGGLEBUTTON:
@GTK_TOOLBAR_CHILD_RADIOBUTTON:
@GTK_TOOLBAR_CHILD_WIDGET:
@GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
@GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
@GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
@GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
@GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
<!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
<para>
......@@ -75,18 +73,15 @@ SPACE is just a space in the style of the toolbar's GtkToolbarSpaceStyle. BUTTON
<!-- ##### FUNCTION gtk_toolbar_new ##### -->
<para>
creates a new toolbar.
Creates a new toolbar.
</para>
@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.
@Returns: the newly-created toolbar.
<!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
<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>
@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 ##### -->
<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>
@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 ##### -->
<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>
@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 ##### -->
<para>
adds a new space to the end of the toolbar.
Adds a new space to the end of the toolbar.
</para>
@toolbar: a #GtkToolbar.
......@@ -140,7 +135,7 @@ adds a new space to the end of the toolbar.
<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
<para>
adds a new space to the beginning of the toolbar.
Adds a new space to the beginning of the toolbar.
</para>
@toolbar: a #GtkToolbar.
......@@ -148,7 +143,7 @@ adds a new space to the beginning of the toolbar.
<!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
<para>
inserts a new space in the toolbar at the specified position.
Inserts a new space in the toolbar at the specified position.
</para>
@toolbar: a #GtkToolbar
......@@ -157,7 +152,7 @@ inserts a new space in the toolbar at the specified position.
<!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
<para>
adds a new element to the end of a toolbar.
Adds a new element to the end of a toolbar.
</para>
@toolbar: a #GtkToolbar.
......@@ -174,7 +169,7 @@ adds a new element to the end of a toolbar.
<!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
<para>
adds a new element to the beginning of a toolbar.
Adds a new element to the beginning of a toolbar.
</para>
@toolbar: a #GtkToolbar.
......@@ -243,7 +238,7 @@ adds a new element to the beginning of a toolbar.
<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
<para>
sets whether a toolbar should appear horizontally or vertically.
Sets whether a toolbar should appear horizontally or vertically.
</para>
@toolbar: a #GtkToolbar.
......@@ -252,7 +247,7 @@ sets whether a toolbar should appear horizontally or vertically.
<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
<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>
@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 ##### -->
<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>
@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 ##### -->
......@@ -290,8 +285,6 @@ sets if the tooltips of a toolbar should be active or not.
@toolbar:
@icon_size:
<!-- # Unused Parameters # -->
@stock_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 ##### -->
<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>
@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 ##### -->
<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>
@toolbar: the object which received the signal.
......
......@@ -6,15 +6,15 @@ A vertical scrollbar
<!-- ##### SECTION Long_Description ##### -->
<para>
The VScrollbar widget is a widget arranged vertically creating a scroll bar. See
#GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be added to
handle the adjustment of the scrollbars or it may be left NULL in which case one
will be created you. See #GtkAdjustment for details.
The #GtkVScrollbar widget is a widget arranged vertically creating a scrollbar.
See #GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be
added to handle the adjustment of the scrollbar or it may be left %NULL in which
case one will be created for you. See #GtkAdjustment for details.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkScrollbar, #GtkScrolledWindow
</para>
<!-- ##### STRUCT GtkVScrollbar ##### -->
......@@ -29,7 +29,7 @@ using the functions below.
Creates a new vertical scrollbar.
</para>
@adjustment:
@Returns: the new GTKVScrollbar
@adjustment: the #GtkAdjustment to use, or %NULL to create a new adjustment.
@Returns: the new #GtkVScrollbar
......@@ -358,29 +358,29 @@ gtk_dialog_new_empty (const gchar *title,
/**
* gtk_dialog_new_with_buttons:
* @title: Title of the dialog, or NULL
* @parent: Transient parent of the dialog, or NULL
* @title: Title of the dialog, or %NULL
* @parent: Transient parent of the dialog, or %NULL
* @flags: from #GtkDialogFlags
* @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
* @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
*
* 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
* NULL for none; see gtk_window_set_transient_for()). The @flags
* argument can be used to make the dialog modal (GTK_DIALOG_MODAL)
* %NULL for none; see gtk_window_set_transient_for()). The @flags
* argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
* and/or to have it destroyed along with its transient parent
* (GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
* text/response ID pairs should be listed, with a NULL pointer ending
* (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
* text/response ID pairs should be listed, with a %NULL pointer ending
* the list. Button text can be either a stock ID such as
* #GTK_STOCK_OK, or some arbitrary text. A response ID can be
* any positive number, or one of the values in the #GtkResponseType
* enumeration. If the user clicks one of these dialog buttons,
* #GtkDialog will emit the "response" signal with the corresponding
* 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;
* 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.
*
* 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
* non-activatable widget, simply pack it into the
* <literal>action_area</literal> field of the #GtkDialog struct.
*
**/
void
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
*
* 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
* text and response ID.
*
**/
void
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
* widget in the dialog's action area with the given @response_id.
* A convenient way to sensitize/desensitize dialog buttons.
*
**/
void
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
* as the default widget for the dialog. Pressing "Enter" normally activates
* the default widget.
*
**/
void
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.
* %TRUE by default.
*
**/
void
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
* 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
* entering the recursive main loop, gtk_dialog_run() calls
* 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
* disabled; if the dialog receives "delete_event", it will not be
* 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
* calling gtk_dialog_response() to emit the "response"
* signal. Destroying the dialog during gtk_dialog_run() is a very bad
......
......@@ -913,11 +913,11 @@ gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf)
/**
* 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*
gtk_icon_set_ref (GtkIconSet *icon_set)
......
......@@ -4184,8 +4184,8 @@ gtk_notebook_get_show_tabs (GtkNotebook *notebook)
/**
* gtk_notebook_set_tab_pos:
* @notebook:
* @pos:
* @notebook: a #GtkNotebook.
* @pos: the edge to draw the tabs at.
*
* Sets the edge at which the tabs for switching pages in the
* notebook are drawn.
......@@ -4253,7 +4253,7 @@ gtk_notebook_set_homogeneous_tabs (GtkNotebook *notebook,
* Sets the width the border around the tab labels
* in a notebook. This is equivalent to calling
* 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
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
* there are too many tabs to fit in the area.
**/
void
gtk_notebook_set_scrollable (GtkNotebook *notebook,
......
......@@ -238,9 +238,10 @@ gtk_radio_button_new_with_label (GSList *group,
* mnemonic character
* @returns: a new #GtkRadioButton
*
* Creates a new #GtkRadioButton containing a label. The label
* will be created using gtk_label_new_with_mnemonic(), so underscores
* in @label indicate the mnemonic for the button.
* Creates a new #GtkRadioButton containing a label, adding it to the same
* group as @group. The label will be created using
* gtk_label_new_with_mnemonic(), so underscores in @label indicate the
* mnemonic for the button.
**/
GtkWidget*
gtk_radio_button_new_with_mnemonic (GSList *group,
......
......@@ -1786,7 +1786,7 @@ gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer,
*
* Returns the mark that represents the cursor (insertion point).
* 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.
*
* Return value: insertion point mark
......@@ -1805,14 +1805,14 @@ gtk_text_buffer_get_insert (GtkTextBuffer *buffer)
* @buffer: a #GtkTextBuffer
*
* Returns the mark that represents the selection bound. Equivalent
* to calling gtk_text_buffer_get_mark () to get the mark name
* "selection_bound," but very slightly more efficient, and involves
* to calling gtk_text_buffer_get_mark () to get the mark named
* "selection_bound", but very slightly more efficient, and involves
* less typing.
*
* The currently-selected text in @buffer is the region between the
* "selection_bound" and "insert" marks. If "selection_bound" and
* "insert" are in the same place, then there is no current selection.
* gtk_text_buffer_get_selection_bounds () is another convenient function
* gtk_text_buffer_get_selection_bounds() is another convenient function
* for handling the selection, if you just want to know whether there's a
* selection and what its bounds are.
*
......@@ -1849,7 +1849,7 @@ gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer *buffer,
*
* This function moves the "insert" and "selection_bound" marks
* simultaneously. If you move them to the same place in two steps
* with gtk_text_buffer_move_mark (), you will temporarily select a
* with gtk_text_buffer_move_mark(), you will temporarily select a
* region in between their old and new locations, which can be pretty
* inefficient since the temporarily-selected region will force stuff
* to be recalculated. This function moves them as a unit, which can
......@@ -1887,7 +1887,7 @@ gtk_text_buffer_place_cursor (GtkTextBuffer *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
* the buffer's tag table, so the ref count will be equal to one.
*
......
......@@ -397,7 +397,7 @@ check_invariants (const GtkTextIter *iter)
* gtk_text_iter_get_buffer:
* @iter: an iterator
*
* Return the #GtkTextBuffer this iterator is associated with
* Returns the #GtkTextBuffer this iterator is associated with.
*
* Return value: the buffer
**/
......@@ -422,7 +422,7 @@ gtk_text_iter_get_buffer (const GtkTextIter *iter)
* gtk_text_iter_copy:
* @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
* simple assignment (<literal>GtkTextIter i = j;</literal>). The
* 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
* especially useful for applications, because iterators can
* simply be allocated on the stack.
*
**/
void
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
* is returned (with no new reference count added). Otherwise,
* NULL is returned.
* %NULL is returned.
*
* 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
* anchor is returned (with no new reference count added). Otherwise,
* NULL is returned.
* %NULL is returned.
*
* Return value: the anchor at @iter
**/
......@@ -1083,10 +1082,10 @@ gtk_text_iter_get_marks (const GtkTextIter *iter)
/**
* gtk_text_iter_get_toggled_tags:
* @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
* 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
* range of characters following @iter has that tag applied to it. If
* 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:
* @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
* 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
* 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
* that the gtk_text_iter_begins_tag () returns %TRUE if @iter is the
* <emphasis>start</emphasis> of the tagged range;
* gtk_text_iter_has_tag () tells you whether an iterator is
* <emphasis>within</emphasis> a tagged range.
......@@ -1187,11 +1186,11 @@ gtk_text_iter_begins_tag (const GtkTextIter *iter,
/**
* gtk_text_iter_ends_tag:
* @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
* 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
* 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
* that the gtk_text_iter_ends_tag () returns %TRUE if @iter is the