From 0a163c7fd7aa6c75c1e4bfb7201380399ad8a750 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 4 Sep 2003 00:49:37 +0000 Subject: [PATCH] Doc tweaks. --- ChangeLog | 1 + ChangeLog.pre-2-10 | 1 + ChangeLog.pre-2-4 | 1 + ChangeLog.pre-2-6 | 1 + ChangeLog.pre-2-8 | 1 + docs/reference/ChangeLog | 4 ++++ docs/reference/gtk/tmpl/gtkactiongroup.sgml | 6 +++--- gtk/gtkactiongroup.c | 22 +++++++++++++-------- 8 files changed, 26 insertions(+), 11 deletions(-) diff --git a/ChangeLog b/ChangeLog index 58996cffd..9b7f1eb5e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -4,6 +4,7 @@ GtkUIManagerNode to shorten the names and to make the GTK_UI_MANAGER_ names available for a public enum. + * gtk/gtkactiongroup.c: * gtk/gtkuimanager.c: Various doc tweaks. * gtk/gtkuimanager.c (start_element_handler): diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 58996cffd..9b7f1eb5e 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -4,6 +4,7 @@ GtkUIManagerNode to shorten the names and to make the GTK_UI_MANAGER_ names available for a public enum. + * gtk/gtkactiongroup.c: * gtk/gtkuimanager.c: Various doc tweaks. * gtk/gtkuimanager.c (start_element_handler): diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 58996cffd..9b7f1eb5e 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -4,6 +4,7 @@ GtkUIManagerNode to shorten the names and to make the GTK_UI_MANAGER_ names available for a public enum. + * gtk/gtkactiongroup.c: * gtk/gtkuimanager.c: Various doc tweaks. * gtk/gtkuimanager.c (start_element_handler): diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 58996cffd..9b7f1eb5e 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -4,6 +4,7 @@ GtkUIManagerNode to shorten the names and to make the GTK_UI_MANAGER_ names available for a public enum. + * gtk/gtkactiongroup.c: * gtk/gtkuimanager.c: Various doc tweaks. * gtk/gtkuimanager.c (start_element_handler): diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 58996cffd..9b7f1eb5e 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -4,6 +4,7 @@ GtkUIManagerNode to shorten the names and to make the GTK_UI_MANAGER_ names available for a public enum. + * gtk/gtkactiongroup.c: * gtk/gtkuimanager.c: Various doc tweaks. * gtk/gtkuimanager.c (start_element_handler): diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d77fbddb4..42f8b085a 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +2003-09-04 Matthias Clasen + + * gtk/tmpl/gtkactiongroup.sgml: Doc tweaks. + 2003-09-02 Matthias Clasen * gtk/tmpl/gtkactiongroup.sgml: diff --git a/docs/reference/gtk/tmpl/gtkactiongroup.sgml b/docs/reference/gtk/tmpl/gtkactiongroup.sgml index ff4f62173..e29725495 100644 --- a/docs/reference/gtk/tmpl/gtkactiongroup.sgml +++ b/docs/reference/gtk/tmpl/gtkactiongroup.sgml @@ -20,9 +20,9 @@ act on that document (eg. save, cut/copy/paste, etc). Each window's menus would be constructed from a combination of two action groups. -Accelerators are handled by the GTK+ accelerator map. All actions are -assigned an accelerator path of the form -<Actions>/group-name/action-name when they are added to an action group, +Accelerators are handled by the GTK+ accelerator map. All actions are assigned an +accelerator path (which normally has the form +<Actions>/group-name/action-name) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The GTK+ accelerator map code makes sure that the correct shortcut is displayed next to the menu item. diff --git a/gtk/gtkactiongroup.c b/gtk/gtkactiongroup.c index 92b97995b..8e35839ec 100644 --- a/gtk/gtkactiongroup.c +++ b/gtk/gtkactiongroup.c @@ -205,7 +205,7 @@ gtk_action_group_get_action (GtkActionGroup *action_group, * @action_group: the action group * @action: an action * - * Adds an action object to the action group. + * Adds an action object to the action group. * * Since: 2.4 */ @@ -223,7 +223,7 @@ gtk_action_group_add_action (GtkActionGroup *action_group, } /** - * gtk_action_group_removes_action: + * gtk_action_group_remove_action: * @action_group: the action group * @action: an action * @@ -284,9 +284,12 @@ gtk_action_group_list_actions (GtkActionGroup *action_group) * @n_entries: the number of entries * @user_data: data to pass to the action callbacks * - * This is a convenience routine to create a number of actions and add - * them to the action group. Each member of the array describes an - * action to create. + * This is a convenience function to create a number of actions and add them to the + * action group. + * + * The "activate" signals of the actions are connected to the callbacks and + * their accel paths are set to + * <Actions>/group-name/action-name. * * Since: 2.4 */ @@ -397,9 +400,12 @@ gtk_action_group_add_actions_full (GtkActionGroup *action_group, * @on_change: the callback to connect to the changed signal * @user_data: data to pass to the action callbacks * - * This is a convenience routine to create a group of radio actions and - * add them to the action group. Each member of the array describes a - * radio action to create. + * This is a convenience routine to create a group of radio actions and + * add them to the action group. + * + * The"changed" signal of the first radio action is connected to the @on_change + * callback and the accel paths of the actions are set to + * <Actions>/group-name/action-name. * * Since: 2.4 **/