+2008-07-21 Matthias Clasen <mclasen@redhat.com>
+
+ * gtk/gtktestutils.c:
+ * gtk/gtkscalebutton.c:
+ * gtk/gtkmessagedialog.c:
+ * gtk/gtkmenu.c:
+ * gtk/gtkcontainer.c:
+ * gtk/gtkcolorseldialog.c:
+ * gtk/gtkaccelgroup.c:
+ * gtk/gtkentry.c:
+ * gtk/gtkfontsel.c: Fix some doc problems.
+
2008-07-21 Michael Natterer <mitch@imendio.com>
* gtk/gtkbox.c (gtk_box_add): use gtk_box_pack_start() instead of
* gtk_accel_group_get_is_locked:
* @accel_group: a #GtkAccelGroup
*
- * @returns: %TRUE if there are 1 or more locks on the @accel_group,
- * %FALSE otherwise.
- *
* Locks are added and removed using gtk_accel_group_lock() and
* gtk_accel_group_unlock().
*
+ * Returns: %TRUE if there are 1 or more locks on the @accel_group,
+ * %FALSE otherwise.
+ *
* Since: 2.14
*/
gboolean
* gtk_accel_group_get_modifier_mask:
* @accel_group: a #GtkAccelGroup
*
- * @returns: #GdkModifierType representing the mask for this
+ * Gets a #GdkModifierType representing the mask for this
* @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
*
+ * Returns: the modifier mask for this accel group.
+ *
* Since: 2.14
*/
GdkModifierType
*
* Retrieves the #GtkColorSelection widget embedded in the dialog.
*
+ * Returns: the embedded #GtkColorSelection
+ *
* Since: 2.14
**/
GtkWidget*
/**
* gtk_container_set_focus_child:
* @container: a #GtkContainer
- * @widget: a #GtkWidget, or %NULL
+ * @child: a #GtkWidget, or %NULL
*
- * Sets, or unsets if @widget is %NULL, the focused child of @container.
+ * Sets, or unsets if @child is %NULL, the focused child of @container.
*
* This function emits the GtkContainer::set_focus_child signal of
* @container. Implementations of #GtkContainer can override the
*/
void
gtk_container_set_focus_child (GtkContainer *container,
- GtkWidget *widget)
+ GtkWidget *child)
{
g_return_if_fail (GTK_IS_CONTAINER (container));
- if (widget)
- g_return_if_fail (GTK_IS_WIDGET (widget));
+ if (child)
+ g_return_if_fail (GTK_IS_WIDGET (child));
- g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, widget);
+ g_signal_emit (container, container_signals[SET_FOCUS_CHILD], 0, child);
}
/**
/**
* gtk_entry_set_overwrite_mode:
* @entry: a #GtkEntry
- * @setting: new value
+ * @overwrite: new value
*
* Sets whether the text is overwritten when typing in the #GtkEntry.
*
**/
void
gtk_entry_set_overwrite_mode (GtkEntry *entry,
- gboolean setting)
+ gboolean overwrite)
{
g_return_if_fail (GTK_IS_ENTRY (entry));
- if (entry->overwrite_mode == setting)
+ if (entry->overwrite_mode == overwrite)
return;
gtk_entry_toggle_overwrite (entry);
* gtk_font_selection_get_family:
* @fontsel: a #GtkFontSelection
*
+ * Gets the #PangoFontFamily representing the selected font family.
+ *
* Return value: A #PangoFontFamily representing the selected font
* family. Font families are a collection of font faces.
*
* gtk_font_selection_get_face:
* @fontsel: a #GtkFontSelection
*
- * Return value: A #PangoFontFace representing the selected font group
+ * Gets the #PangoFontFace representing the selected font group
* details (i.e. family, slant, weight, width, etc).
*
+ * Return value: A #PangoFontFace representing the selected font group
+ * details
+ *
* Since: 2.14
**/
PangoFontFace *
* gtk_font_selection_get_size:
* @fontsel: a #GtkFontSelection
*
+ * The selected font size.
+ *
* Return value: A #gint representing the font size selected, or -1
* if not.
*
* gtk_font_selection_dialog_get_ok_button:
* @fsd: a #GtkFontSelectionDialog
*
+ * Gets the 'OK' button.
+ *
* Return value: the #GtkWidget used in the dialog for the 'OK' button.
*
* Since: 2.14
* gtk_font_selection_dialog_get_apply_button:
* @fsd: a #GtkFontSelectionDialog
*
+ * Gets the 'Apply' button.
+ *
* Return value: the #GtkWidget used in the dialog for the 'Apply' button.
*
* Since: 2.14
}
/**
- * gtk_font_selection_dialog_get_apply_button:
+ * gtk_font_selection_dialog_get_cancel_button:
* @fsd: a #GtkFontSelectionDialog
*
+ * Gets the 'Cancel' button.
+ *
* Return value: the #GtkWidget used in the dialog for the 'Cancel' button.
*/
GtkWidget *
*
* Retrieves the accelerator path set on the menu.
*
+ * Returns: the accelerator path set on the menu.
+ *
* Since: 2.14
*/
const gchar*
* gtk_message_dialog_get_image:
* @dialog: a #GtkMessageDialog
*
+ * Gets the dialog's image.
+ *
* Return value: the dialog's image
*
* Since: 2.14
*
* Retrieves the plus button of the #GtkScaleButton.
*
+ * Returns: the plus button of the #GtkScaleButton.
+ *
* Since: 2.14
*/
GtkWidget *
*
* Retrieves the minus button of the #GtkScaleButton.
*
+ * Returns: the minus button of the #GtkScaleButton.
+ *
* Since: 2.14
*/
GtkWidget *
* @argvp: Address of the <parameter>argv</parameter> parameter of main().
* Any parameters understood by g_test_init() or gtk_init() are
* stripped before return.
+ * @Varargs: currently unused
+ *
+ * This function is used to initialize a GTK+ test program.
*
- * This function is used to initialize a Gtk+ test program.
* It will in turn call g_test_init() and gtk_init() to properly
- * initialize the testing framework and graphical toolkit.
- * It'll also set the program's locale to "C" and prevent loading of
- * rc files and Gtk+ modules. This is done to make tets program
+ * initialize the testing framework and graphical toolkit. It'll
+ * also set the program's locale to "C" and prevent loading of rc
+ * files and Gtk+ modules. This is done to make tets program
* environments as deterministic as possible.
+ *
* Like gtk_init() and g_test_init(), any known arguments will be
* processed and stripped from @argc and @argv.
**/
/**
* gtk_test_create_widget
- * @widget_type: valid widget type.
+ * @widget_type: a valid widget type.
* @first_property_name: Name of first property to set or %NULL
+ * @Varags: value to set the first property to, followed by more
+ * name-value pairs, terminated by %NULL
*
* This function wraps g_object_new() for widget types.
* It'll automatically show all created non window widgets, also
projects / ~andy / gtk / commitdiff