diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2001-12-08 21:39:34 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2001-12-08 21:39:34 +0000 |
commit | 63b4e379579be48c2fbbd067cc273c41a3444aa0 (patch) | |
tree | a51161fd834097dbf3a7922869203f758f2ecf1b | |
parent | 1d0e9b7f289cac390509778007c32d93f7a48e3e (diff) | |
download | gtk+-63b4e379579be48c2fbbd067cc273c41a3444aa0.tar.gz |
Doc markup fix.
* gtk/gtkwidget.c: Doc markup fix.
* gtk/gtktreeviewcolumn.c: Markup fixes. (#66447)
* gtk/gtktreestore.c: Typo fixes. (#66445)
* gtk/gtkaccelgroup.c: Misc doc markup. (#66425)
* gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference
to gtk_clipboard_set_with_owner(). (#66424)
* gtk/tmpl/gtkclipboard.sgml: Fix references to
get_clipboard_set_with_owner(). (#66424)
-rw-r--r-- | ChangeLog | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-0 | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-10 | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-2 | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-4 | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-6 | 13 | ||||
-rw-r--r-- | ChangeLog.pre-2-8 | 13 | ||||
-rw-r--r-- | docs/reference/ChangeLog | 5 | ||||
-rw-r--r-- | docs/reference/gtk/tmpl/gtkclipboard.sgml | 4 | ||||
-rw-r--r-- | gtk/gtkaccelgroup.c | 63 | ||||
-rw-r--r-- | gtk/gtkclipboard.c | 19 | ||||
-rw-r--r-- | gtk/gtktreestore.c | 20 | ||||
-rw-r--r-- | gtk/gtktreeviewcolumn.c | 68 | ||||
-rw-r--r-- | gtk/gtkwidget.c | 2 |
14 files changed, 188 insertions, 84 deletions
@@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 183e07d8c4..c1e4f337ba 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,16 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/gtkwidget.c: Doc markup fix. + + * gtk/gtktreeviewcolumn.c: Markup fixes. (#66447) + + * gtk/gtktreestore.c: Typo fixes. (#66445) + + * gtk/gtkaccelgroup.c: Misc doc markup. (#66425) + + * gtk/gtkclipboard.c (gtk_clipboard_get_owner): Fix reference + to gtk_clipboard_set_with_owner(). (#66424) + Sat Dec 8 16:12:10 2001 Christopher Blizzard <blizzard@redhat.com> * gdk/gdk.c (gdk_init_check): Fallback to setting the prgname to diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index bef27ef1a1..94c1ed28a6 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2001-12-08 Matthias Clasen <matthiasc@poet.de> + + * gtk/tmpl/gtkclipboard.sgml: Fix references to + get_clipboard_set_with_owner(). (#66424) + 2001-12-07 Matthias Clasen <matthiasc@poet.de> * gtk/tmpl/gtktypeutils.sgml, gtk/tmpl/gtkobject.sgml, diff --git a/docs/reference/gtk/tmpl/gtkclipboard.sgml b/docs/reference/gtk/tmpl/gtkclipboard.sgml index 41bdfb2277..059eebcc21 100644 --- a/docs/reference/gtk/tmpl/gtkclipboard.sgml +++ b/docs/reference/gtk/tmpl/gtkclipboard.sgml @@ -134,7 +134,7 @@ will be informed that the attempt to get the data failed. target from the #GtkTargetEntry array passed to gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner(). @user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or - the @owner argument passed to gtk_clipboard_set_owner() + the @owner argument passed to gtk_clipboard_set_with_owner() <!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### --> @@ -146,7 +146,7 @@ will not be used again. @clipboard: the #GtkClipboard @user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or - the @owner argument passed to gtk_clipboard_set_owner() + the @owner argument passed to gtk_clipboard_set_with_owner() <!-- ##### FUNCTION gtk_clipboard_get ##### --> diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c index a502943223..0e9b4866a6 100644 --- a/gtk/gtkaccelgroup.c +++ b/gtk/gtkaccelgroup.c @@ -52,8 +52,8 @@ static guint default_accel_mod_mask = (GDK_SHIFT_MASK | /* --- functions --- */ /** - * gtk_accel_group_get_type - * @returns: the type ID for accelerator groups + * gtk_accel_group_get_type: + * @returns: the type ID for accelerator groups. */ GType gtk_accel_group_get_type (void) @@ -165,7 +165,7 @@ gtk_accel_group_init (GtkAccelGroup *accel_group) } /** - * gtk_accel_group_new + * gtk_accel_group_new: * @returns: a new #GtkAccelGroup object * * Creates a new #GtkAccelGroup. @@ -277,9 +277,11 @@ gtk_accel_group_find (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_lock + * gtk_accel_group_lock: * @accel_group: a #GtkAccelGroup * + * Locks the given accelerator group. + * * Locking an acelerator group prevents the accelerators contained * within it to be changed during runtime. Refer to * gtk_accel_map_change_entry() about runtime accelerator changes. @@ -297,11 +299,10 @@ gtk_accel_group_lock (GtkAccelGroup *accel_group) } /** - * gtk_accel_group_unlock + * gtk_accel_group_unlock: * @accel_group: a #GtkAccelGroup * - * This function undoes the last call to gtk_accel_group_lock() - * on this @accel_group. + * Undoes the last call to gtk_accel_group_lock() on this @accel_group. */ void gtk_accel_group_unlock (GtkAccelGroup *accel_group) @@ -463,18 +464,20 @@ quick_accel_find (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_connect - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_connect: + * @accel_group: the accelerator group to install an accelerator in * @accel_key: key value of the accelerator * @accel_mods: modifier combination of the accelerator * @accel_flags: a flag mask to configure this accelerator * @closure: closure to be executed upon accelerator activation * - * Install an accelerator in this group. When @accel_group is being activated + * Installs an accelerator in this group. When @accel_group is being activated * in response to a call to gtk_accel_groups_activate(), @closure will be * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate() * match those of this connection. + * * The signature used for the @closure is that of #GtkAccelGroupActivate. + * * Note that, due to implementation details, a single closure can only be * connected to one accelerator group. */ @@ -497,17 +500,18 @@ gtk_accel_group_connect (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_connect_by_path - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_connect_by_path: + * @accel_group: the accelerator group to install an accelerator in * @accel_path: path used for determining key and modifiers. * @closure: closure to be executed upon accelerator activation * - * Install an accelerator in this group, using a accelerator path to look - * up the appropriate key and modifiers. (See gtk_accel_map_add_entry()) + * Installs an accelerator in this group, using an accelerator path to look + * up the appropriate key and modifiers (see gtk_accel_map_add_entry()). * When @accel_group is being activated in response to a call to * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and * @accel_mods from gtk_accel_groups_activate() match the key and modifiers * for the path. + * * The signature used for the @closure is that of #GtkAccelGroupActivate. */ void @@ -541,12 +545,12 @@ gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_disconnect + * gtk_accel_group_disconnect: * @accel_group: the accelerator group to remove an accelerator from * @closure: the closure to remove from this accelerator group * @returns: %TRUE if the closure was found and got disconnected * - * Remove an accelerator previously installed through + * Removes an accelerator previously installed through * gtk_accel_group_connect(). */ gboolean @@ -569,13 +573,14 @@ gtk_accel_group_disconnect (GtkAccelGroup *accel_group, } /** - * gtk_accel_group_disconnect_key - * @accel_group: the ccelerator group to install an accelerator in + * gtk_accel_group_disconnect_key: + * @accel_group: the accelerator group to install an accelerator in * @accel_key: key value of the accelerator * @accel_mods: modifier combination of the accelerator - * @returns: %TRUE if there was an accelerator which could be removed, %FALSE otherwise + * @returns: %TRUE if there was an accelerator which could be + * removed, %FALSE otherwise * - * Remove an accelerator previously installed through + * Removes an accelerator previously installed through * gtk_accel_group_connect(). */ gboolean @@ -744,14 +749,14 @@ gtk_accel_groups_activate (GObject *object, } /** - * gtk_accelerator_valid + * gtk_accelerator_valid: * @keyval: a GDK keyval * @modifiers: modifier mask * @returns: %TRUE if the accelerator is valid * * Determines whether a given keyval and modifier mask constitute - * a valid keyboard accelerator. For example, the GDK_a keyval - * plus GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. + * a valid keyboard accelerator. For example, the #GDK_a keyval + * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator. * But by default (see gtk_accelerator_set_default_mod_mask()) you * cannot use the NumLock key as an accelerator modifier. */ @@ -884,7 +889,7 @@ is_release (const gchar *string) } /** - * gtk_accelerator_parse + * gtk_accelerator_parse: * @accelerator: string representing an accelerator * @accelerator_key: return location for accelerator keyval * @accelerator_mods: return location for accelerator modifier mask @@ -1002,14 +1007,14 @@ gtk_accelerator_parse (const gchar *accelerator, } /** - * gtk_accelerator_name + * gtk_accelerator_name: * @accelerator_key: accelerator keyval * @accelerator_mods: accelerator modifier mask - * @returns: a newly allocated accelerator name + * @returns: a newly-allocated accelerator name * * Converts an accelerator keyval and modifier mask * into a string parseable by gtk_accelerator_parse(). - * For example, if you pass in GDK_q and GDK_CONTROL_MASK, + * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK, * this function returns "<Control>q". * * The caller of this function must free the returned string. @@ -1105,7 +1110,7 @@ gtk_accelerator_name (guint accelerator_key, } /** - * gtk_accelerator_set_default_mod_mask + * gtk_accelerator_set_default_mod_mask: * @default_mod_mask: accelerator modifier mask * * Sets the modifiers that will be considered significant for keyboard @@ -1123,7 +1128,7 @@ gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask) } /** - * gtk_accelerator_get_default_mod_mask + * gtk_accelerator_get_default_mod_mask: * @returns: the default accelerator modifier mask * * Gets the value set by gtk_accelerator_set_default_mod_mask(). diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c index dab3d3e051..ae4357f96f 100644 --- a/gtk/gtkclipboard.c +++ b/gtk/gtkclipboard.c @@ -89,7 +89,7 @@ static GQuark clipboards_owned_key_id = 0; * gtk_clipboard_get: * @selection: a #GdkAtom which identifies the clipboard * to use. A value of %GDK_NONE here is the - * same as gdk_atom_intern ("CLIPBOARD", FALSE), + * same as <literal>gdk_atom_intern ("CLIPBOARD", FALSE)</literal>, * and provides the default clipboard. Another * common value is %GDK_SELECTION_PRIMARY, which * identifies the primary X selection. @@ -403,7 +403,7 @@ gtk_clipboard_set_with_data (GtkClipboard *clipboard, * a list of supported formats for the clipboard data and a function * to call to get the actual data when it is requested. * - * The difference between this function and gtk_clipboard_set_with_data + * The difference between this function and gtk_clipboard_set_with_data() * is that instead of an generic @user_data pointer, a #GObject is passed * in. * @@ -433,9 +433,10 @@ gtk_clipboard_set_with_owner (GtkClipboard *clipboard, * gtk_clipboard_get_owner: * @clipboard: a #GtkClipboard * - * If the clipboard contents callbacks were set with gtk_clipboard_set_owner(), - * and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not - * subsequently called, returns the @owner set by gtk_clipboard_set_owner(). + * If the clipboard contents callbacks were set with + * gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or + * gtk_clipboard_clear() has not subsequently called, returns the @owner set + * by gtk_clipboard_set_with_owner(). * * Return value: the owner of the clipboard, if any; otherwise %NULL. **/ @@ -513,7 +514,7 @@ text_clear_func (GtkClipboard *clipboard, * @clipboard: a #GtkClipboard object * @text: a UTF-8 string. * @len: length of @text, in bytes, or -1, in which case - * the length will be determined with strlen(). + * the length will be determined with <function>strlen()</function>. * * Sets the contents of the clipboard to the given UTF-8 string. GTK+ will * make a copy of the text and take responsibility for responding @@ -732,10 +733,10 @@ clipboard_received_func (GtkClipboard *clipboard, * This function waits for the data to be received using the main * loop, so events, timeouts, etc, may be dispatched during the wait. * - * Return value: a newly allocated #GtkSelectionData object or %NULL + * Return value: a newly-allocated #GtkSelectionData object or %NULL * if retrieving the given target failed. If non-%NULL, - * this value freed with gtk_selection_data_free() when - * you are finished with it. + * this value must be freed with gtk_selection_data_free() + * when you are finished with it. **/ GtkSelectionData * gtk_clipboard_wait_for_contents (GtkClipboard *clipboard, diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c index 4907b680e1..d9e38832a2 100644 --- a/gtk/gtktreestore.c +++ b/gtk/gtktreestore.c @@ -345,12 +345,12 @@ gtk_tree_store_newv (gint n_columns, * gtk_tree_store_set_column_types: * @tree_store: A #GtkTreeStore * @n_columns: Number of columns for the tree store - * @types: An array length n of @GTypes + * @types: An array of #GType types, one for each column * - * This function is meant primarily for GObjects that inherit from GtkTreeStore, - * and should only be used when constructing a new @GtkTreeStore. It will not - * function after a row has been added, or a method on the @GtkTreeModel - * interface is called. + * This function is meant primarily for #GObjects that inherit from + * #GtkTreeStore, and should only be used when constructing a new + * #GtkTreeStore. It will not function after a row has been added, + * or a method on the #GtkTreeModel interface is called. **/ void gtk_tree_store_set_column_types (GtkTreeStore *tree_store, @@ -893,9 +893,9 @@ gtk_tree_store_set_value (GtkTreeStore *tree_store, * gtk_tree_store_set_valist: * @tree_store: A #GtkTreeStore * @iter: A valid #GtkTreeIter for the row being modified - * @var_args: va_list of column/value pairs + * @var_args: <type>va_list</type> of column/value pairs * - * See gtk_tree_store_set(); this version takes a va_list for + * See gtk_tree_store_set(); this version takes a <type>va_list</type> for * use by language bindings. * **/ @@ -965,8 +965,8 @@ gtk_tree_store_set_valist (GtkTreeStore *tree_store, * The variable argument list should contain integer column numbers, * each column number followed by the value to be set. * The list is terminated by a -1. For example, to set column 0 with type - * %G_TYPE_STRING to "Foo", you would write <literal>gtk_tree_store_set (store, iter, - * 0, "Foo", -1)</literal>. + * %G_TYPE_STRING to "Foo", you would write + * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>. **/ void gtk_tree_store_set (GtkTreeStore *tree_store, @@ -1391,7 +1391,7 @@ gtk_tree_store_iter_depth (GtkTreeStore *tree_store, /** * gtk_tree_store_clear: - * @tree_store: @ #GtkTreeStore + * @tree_store: a #GtkTreeStore * * Removes all rows from @tree_store **/ diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c index c66b925b8f..d441e1c07a 100644 --- a/gtk/gtktreeviewcolumn.c +++ b/gtk/gtktreeviewcolumn.c @@ -1032,12 +1032,12 @@ gtk_tree_view_column_new (void) * gtk_tree_view_column_new_with_attributes: * @title: The title to set the header to. * @cell: The #GtkCellRenderer. - * @Varargs: A NULL terminated list of attributes. + * @Varargs: A %NULL-terminated list of attributes. * * Creates a new #GtkTreeViewColumn with a number of default values. This is - * equivalent to calling @gtk_tree_view_column_set_title, - * @gtk_tree_view_column_pack_start, and - * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn. + * equivalent to calling gtk_tree_view_column_set_title(), + * gtk_tree_view_column_pack_start(), and + * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn. * * Return value: A newly created #GtkTreeViewColumn. **/ @@ -1076,8 +1076,8 @@ gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_pack_start: * @tree_column: A #GtkTreeViewColumn. - * @cell: The #GtkCellRenderer, - * @expand: TRUE if @cell is to be given extra space allocated to box. + * @cell: The #GtkCellRenderer. + * @expand: %TRUE if @cell is to be given extra space allocated to box. * **/ void @@ -1158,8 +1158,8 @@ gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column) * gtk_tree_view_column_get_cell_renderers: * @tree_column: A #GtkTreeViewColumn * - * Returns a newly allocated #GList of all the cell renderers in the column, in no - * particular order. The list must be freed with g_list_free() + * Returns a newly-allocated #GList of all the cell renderers in the column, + * in no particular order. The list must be freed with g_list_free(). * * Return value: A list of #GtkCellRenderers **/ @@ -1238,11 +1238,11 @@ gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column, * gtk_tree_view_column_set_attributes: * @tree_column: A #GtkTreeViewColumn. * @cell_renderer: the #GtkCellRenderer we're setting the attributes of - * @Varargs: A NULL terminated listing of attributes. + * @Varargs: A %NULL-terminated list of attributes. * * Sets the attributes in the list as the attributes of @tree_column. * The attributes should be in attribute/column order, as in - * @gtk_tree_view_column_add_attribute. All existing attributes + * gtk_tree_view_column_add_attribute(). All existing attributes * are removed, and replaced with the new attributes. **/ void @@ -1273,7 +1273,7 @@ gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column, * Sets the #GtkTreeViewColumnFunc to use for the column. This * function is used instead of the standard attributes mapping for * setting the column value, and should set the value of @tree_column's - * cell renderer as appropriate. @func may be NULL to remove an + * cell renderer as appropriate. @func may be %NULL to remove an * older one. **/ void @@ -1311,7 +1311,7 @@ gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column, /** * gtk_tree_view_column_clear_attributes: * @tree_column: a #GtkTreeViewColumn - *@cell_renderer: a #GtkCellRenderer to clear the attribute mapping on. + * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on. * * Clears all existing attributes previously set with * gtk_tree_view_column_set_attributes(). @@ -1370,6 +1370,8 @@ gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column, * @tree_column: A #GtkTreeViewColumn. * * Returns the spacing of @tree_column. + * + * Return value: the spacing of @tree_column. **/ gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column) @@ -1384,7 +1386,7 @@ gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_visible: * @tree_column: A #GtkTreeViewColumn. - * @visible: TRUE if the @tree_column is visible. + * @visible: %TRUE if the @tree_column is visible. * * Sets the visibility of @tree_column. **/ @@ -1409,7 +1411,7 @@ gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column, * gtk_tree_view_column_get_visible: * @tree_column: A #GtkTreeViewColumn. * - * Returns TRUE if @tree_column is visible. + * Returns %TRUE if @tree_column is visible. * * Return value: whether the column is visible or not. If it is visible, then * the tree will show the column. @@ -1508,9 +1510,9 @@ gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column) * gtk_tree_view_column_get_width: * @tree_column: A #GtkTreeViewColumn. * - * Returns the current size of the @tree_column in pixels. + * Returns the current size of @tree_column in pixels. * - * Return value: The current width of the @tree_column. + * Return value: The current width of @tree_column. **/ gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column) @@ -1523,7 +1525,7 @@ gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_fixed_width: * @tree_column: A #GtkTreeViewColumn. - * @fixed_width: The size to set the @tree_column to. Must be greater than 0. + * @fixed_width: The size to set @tree_column to. Must be greater than 0. * * Sets the size of the column in pixels. This is meaningful only if the sizing * type is #GTK_TREE_VIEW_COLUMN_FIXED. In this case, the value is discarded @@ -1734,9 +1736,9 @@ gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_clickable: * @tree_column: A #GtkTreeViewColumn. - * @clickable: TRUE if the header is active. + * @clickable: %TRUE if the header is active. * - * Sets the header to be active if @active is TRUE. When the header is active, + * Sets the header to be active if @active is %TRUE. When the header is active, * then it can take keyboard focus, and can be clicked. **/ void @@ -1760,7 +1762,7 @@ gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column, * * Returns %TRUE if the user can click on the header for the column. * - * Return value: TRUE if user can click the column header + * Return value: %TRUE if user can click the column header. **/ gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column) @@ -1773,9 +1775,9 @@ gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_widget: * @tree_column: A #GtkTreeViewColumn. - * @widget: A child #GtkWidget, or NULL. + * @widget: A child #GtkWidget, or %NULL. * - * Sets the widget in the header to be @widget. If widget is NULL, then the + * Sets the widget in the header to be @widget. If widget is %NULL, then the * header button is set with a #GtkLabel set to the title of @tree_column. **/ void @@ -1888,10 +1890,10 @@ gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column) /** * gtk_tree_view_column_set_sort_column_id: * @tree_column: a #GtkTreeViewColumn - * @sort_column_id: The sort_column_id of the model to sort on. + * @sort_column_id: The @sort_column_id of the model to sort on. * - * Sets the logical sort_column_id that this column sorts on when this column is - * selected for sorting. Doing so makes the column header clickable. + * Sets the logical @sort_column_id that this column sorts on when this column + * is selected for sorting. Doing so makes the column header clickable. **/ void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column, @@ -1940,10 +1942,10 @@ gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column, * gtk_tree_view_column_get_sort_column_id: * @tree_column: a #GtkTreeViewColumn * - * Gets the logical sort_column_id that the model sorts on when this - * coumn is selected for sorting. See gtk_tree_view_column_set_sort_column_id(). + * Gets the logical @sort_column_id that the model sorts on when this + * column is selected for sorting. See gtk_tree_view_column_set_sort_column_id(). * - * Return value: the current sort_column_id for this column, or -1 if + * Return value: the current @sort_column_id for this column, or -1 if * this column can't be used for sorting. **/ gint @@ -2049,13 +2051,13 @@ gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column) * @tree_column: A #GtkTreeViewColumn. * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from. * @iter: The #GtkTreeIter to to get the cell renderer's attributes from. - * @is_expander: TRUE, if the row has children - * @is_expanded: TRUE, if the row has visible children + * @is_expander: %TRUE, if the row has children + * @is_expanded: %TRUE, if the row has visible children * * Sets the cell renderer based on the @tree_model and @tree_node. That is, for * every attribute mapping in @tree_column, it will get a value from the set * column on the @tree_node, and use that value to set the attribute on the cell - * renderer. This is used primarily by the GtkTreeView. + * renderer. This is used primarily by the #GtkTreeView. **/ void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column, @@ -2111,7 +2113,7 @@ gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column, * @height: location to return height needed to render a cell, or %NULL * * Obtains the width and height needed to render the column. This is used - * primarily by the GtkTreeView. + * primarily by the #GtkTreeView. **/ void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column, @@ -2301,7 +2303,7 @@ gtk_tree_view_column_cell_render_or_focus (GtkTreeViewColumn *tree_column, * @flags: flags that affect rendering * * Renders the cell contained by #tree_column. This is used primarily by the - * GtkTreeView. + * #GtkTreeView. **/ void gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column, diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index a3f24e4342..f2467f585b 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -2653,7 +2653,7 @@ gtk_widget_add_accelerator (GtkWidget *widget, } /** - * gtk_widget_remove_accelerator + * gtk_widget_remove_accelerator: * @widget: widget to install an accelerator on * @accel_group: accel group for this widget * @accel_key: GDK keyval of the accelerator |