AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

[GI] Cosmetic cleanups of annotations and doc comments

Browse Source 
This change does not introduce any functionality change, mostly
cosmtic cleanups, like re-linebreak when introduced annotations messed
up indentation or whitespace errors fixes.
This commit is contained in:
Pavel Holejsovsky 2011-01-18 10:12:38 +01:00
parent fe372ddf5e
commit a1c297a310
18 changed files with 45 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gdk/gdk.c
View File

@ -777,7 +777,7 @@ gdk_threads_dispatch_free (gpointer data)
/**
* gdk_threads_add_idle_full:
* @priority: the priority of the idle source. Typically this will be in the
* range btweeen #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
* range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
* @function: function to call
* @data: data to pass to @function
* @notify: (allow-none): function to call when the idle is removed, or %NULL

2
gdk/gdkcursor.c
View File

@ -355,7 +355,7 @@ gdk_cursor_new_from_pixbuf (GdkDisplay *display,
return GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_pixbuf (display, pixbuf, x, y);
}
/**
/**
* gdk_cursor_get_display:
* @cursor: a #GdkCursor.
*

2
gdk/gdkkeys.c
View File

@ -284,7 +284,7 @@ gdk_keyval_is_lower (guint keyval)
return FALSE;
}
/**
/**
* gdk_keymap_get_default:
*
* Returns the #GdkKeymap attached to the default display.

7
gtk/gtkaccelgroup.c
View File

@ -819,8 +819,11 @@ _gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group)
* @accel_group: the accelerator group to query
* @accel_key: key value of the accelerator
* @accel_mods: modifier combination of the accelerator
* @n_entries: (allow-none): location to return the number of entries found, or %NULL
* @returns: (allow-none): an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
* @n_entries: (allow-none): location to return the number of entries found,
* or %NULL
* @returns: (transfer none) (array length=n_entries): an array of
* @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is
* owned by GTK+ and must not be freed.
*
* Queries an accelerator group for all entries matching @accel_key and
* @accel_mods.

3
gtk/gtkaction.c
View File

@ -506,7 +506,8 @@ gtk_action_buildable_get_name (GtkBuildable *buildable)
/**
* gtk_action_new:
* @name: A unique name for the action
* @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
* @label: (allow-none): the label displayed in menu items and on buttons,
* or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
* @stock_id: (allow-none): the stock icon to display in widgets representing
* the action, or %NULL

2
gtk/gtkbutton.c
View File

@ -301,7 +301,7 @@ gtk_button_class_init (GtkButtonClass *klass)
GTK_PARAM_READWRITE));
/**
* GtkButton::image:
* GtkButton:image:
*
* The child widget to appear next to the button text.
*

3
gtk/gtkdialog.c
View File

@ -1131,7 +1131,8 @@ gtk_dialog_run (GtkDialog *dialog)
* Gets the widget button that uses the given response ID in the action area
* of a dialog.
*
* Returns: (transfer none):the @widget button that uses the given @response_id, or %NULL.
* Returns: (transfer none): the @widget button that uses the given
* @response_id, or %NULL.
*
* Since: 2.20
*/

6
gtk/gtkfilechooser.c
View File

@ -2447,9 +2447,9 @@ gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder_uri().
*
* Return value: (element-type utf8) (transfer full): A list of folder URIs, or %NULL if there are no shortcut
* folders. Free the returned list with g_slist_free(), and the URIs with
* g_free().
* Return value: (element-type utf8) (transfer full): A list of folder
* URIs, or %NULL if there are no shortcut folders. Free the returned
* list with g_slist_free(), and the URIs with g_free().
*
* Since: 2.4
**/

8
gtk/gtkicontheme.c
View File

@ -1793,10 +1793,10 @@ gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
* Gets the list of contexts available within the current
* hierarchy of icon themes
*
* Return value: (element-type utf8) (transfer full): a #GList list holding the names of all the
* contexts in the theme. You must first free each element
* in the list with g_free(), then free the list itself
* with g_list_free().
* Return value: (element-type utf8) (transfer full): a #GList list
* holding the names of all the contexts in the theme. You must first
* free each element in the list with g_free(), then free the list
* itself with g_list_free().
*
* Since: 2.12
**/

2
gtk/gtkiconview.c
View File

@ -4562,7 +4562,7 @@ gtk_icon_view_set_tooltip_column (GtkIconView *icon_view,
g_object_notify (G_OBJECT (icon_view), "tooltip-column");
}
/**
/**
* gtk_icon_view_get_tooltip_column:
* @icon_view: a #GtkIconView
*

2
gtk/gtkimcontextsimple.c
View File

@ -155,7 +155,7 @@ gtk_im_context_simple_finalize (GObject *obj)
G_OBJECT_CLASS (gtk_im_context_simple_parent_class)->finalize (obj);
}
/**
/**
* gtk_im_context_simple_new:
*
* Creates a new #GtkIMContextSimple.

6
gtk/gtkmenu.c
View File

@ -1337,9 +1337,9 @@ gtk_menu_remove (GtkContainer *container,
/**
* gtk_menu_new:
*
* Creates a new #GtkMenu.
* Creates a new #GtkMenu
*
* Returns: a new #GtkMenu.
* Returns: a new #GtkMenu
*/
GtkWidget*
gtk_menu_new (void)
@ -1444,7 +1444,7 @@ popup_grab_on_window (GdkWindow *window,
/**
* gtk_menu_popup_for_device:
* @menu: a #GtkMenu.
* @menu: a #GtkMenu
* @device: (allow-none): a #GdkDevice
* @parent_menu_shell: (allow-none): the menu shell containing the triggering
* menu item, or %NULL

3
gtk/gtkradioaction.c
View File

@ -193,7 +193,8 @@ gtk_radio_action_init (GtkRadioAction *action)
/**
* gtk_radio_action_new:
* @name: A unique name for the action
* @label: (allow-none): The label displayed in menu items and on buttons, or %NULL
* @label: (allow-none): The label displayed in menu items and on buttons,
* or %NULL
* @tooltip: (allow-none): A tooltip for this action, or %NULL
* @stock_id: (allow-none): The stock icon to display in widgets representing
* this action, or %NULL

2
gtk/gtkradiobutton.c
View File

@ -175,7 +175,7 @@ gtk_radio_button_class_init (GtkRadioButtonClass *class)
/**
* GtkRadioButton::group-changed:
* @style: the object which received the signal
* @button: the object which received the signal
*
* Emitted when the group of radio buttons that a radio button belongs
* to changes. This is emitted when a radio button switches from

6
gtk/gtkrecentaction.c
View File

@ -670,7 +670,8 @@ gtk_recent_action_init (GtkRecentAction *action)
/**
* gtk_recent_action_new:
* @name: a unique name for the action
* @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
* @label: (allow-none): the label displayed in menu items and on buttons,
* or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
* @stock_id: (allow-none): the stock icon to display in widgets representing
* the action, or %NULL
@ -702,7 +703,8 @@ gtk_recent_action_new (const gchar *name,
/**
* gtk_recent_action_new_for_manager:
* @name: a unique name for the action
* @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
* @label: (allow-none): the label displayed in menu items and on buttons,
* or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
* @stock_id: (allow-none): the stock icon to display in widgets representing
* the action, or %NULL

16
gtk/gtkstatusicon.c
View File

@ -2464,14 +2464,14 @@ gtk_status_icon_position_menu (GtkMenu *menu,
/**
* gtk_status_icon_get_geometry:
* @status_icon: a #GtkStatusIcon
* @screen: (out) (transfer none) (allow-none): return location for the screen, or %NULL if the
* information is not needed
* @area: (out) (allow-none): return location for the area occupied by the status
* icon, or %NULL
* @orientation: (out) (allow-none): return location for the orientation of the panel
* in which the status icon is embedded, or %NULL. A panel
* at the top or bottom of the screen is horizontal, a panel
* at the left or right is vertical.
* @screen: (out) (transfer none) (allow-none): return location for
* the screen, or %NULL if the information is not needed
* @area: (out) (allow-none): return location for the area occupied by
* the status icon, or %NULL
* @orientation: (out) (allow-none): return location for the
* orientation of the panel in which the status icon is embedded,
* or %NULL. A panel at the top or bottom of the screen is
* horizontal, a panel at the left or right is vertical.
*
* Obtains information about the location of the status icon
* on screen. This information can be used to e.g. position

3
gtk/gtktoggleaction.c
View File

@ -166,7 +166,8 @@ gtk_toggle_action_init (GtkToggleAction *action)
/**
* gtk_toggle_action_new:
* @name: A unique name for the action
* @label: (allow-none): The label displayed in menu items and on buttons, or %NULL
* @label: (allow-none): The label displayed in menu items and on buttons,
* or %NULL
* @tooltip: (allow-none): A tooltip for the action, or %NULL
* @stock_id: (allow-none): The stock icon to display in widgets representing
* the action, or %NULL

6
gtk/gtkwindow.c
View File

@ -8048,7 +8048,7 @@ gtk_window_begin_move_drag (GtkWindow *window,
timestamp);
}
/**
/**
* gtk_window_set_screen:
* @window: a #GtkWindow.
* @screen: a #GdkScreen.
@ -8335,8 +8335,8 @@ gtk_window_group_remove_window (GtkWindowGroup *window_group,
*
* Returns a list of the #GtkWindows that belong to @window_group.
*
* Returns: (element-type GtkWidget) (transfer container): A newly-allocated list of
* windows inside the group.
* Returns: (element-type GtkWindow) (transfer container): A
* newly-allocated list of windows inside the group.
*
* Since: 2.14
**/