IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix parameter names in comments.

Browse Source 
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@7014 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
David Hampton 2002-06-24 08:10:28 +00:00
parent 97f77cca4a
commit 775e588af0
5 changed files with 63 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@ -1,3 +1,10 @@
2002-06-24 David Hampton <hampton@employees.org>
* src/gnome-utils/gnc-mdi-utils.c:
* src/gnome/dialog-price-edit-db.c:
* src/gnome/window-acct-tree.c:
* src/gnome/window-main.c: Fix parameter names in documentation.
2002-06-23 Joshua Sled <jsled@asynchronous.org> 2002-06-23 Joshua Sled <jsled@asynchronous.org>
* src/gnome/dialog-sxsincelast.c: Lists of SX instances [the * src/gnome/dialog-sxsincelast.c: Lists of SX instances [the

62
src/gnome-utils/gnc-mdi-utils.c
View File

@ -99,8 +99,8 @@ gnc_mdi_set_toolbar_visibility (gboolean visible)
/** /**
* gnc_mdi_widget_show * gnc_mdi_widget_show
* *
* @par1: The widget to modify. * @data: The widget to modify.
* @par2: TRUE if the widget should be shown, FALSE if hidden. * @user_data: TRUE if the widget should be shown, FALSE if hidden.
* *
* This routine is merely a wrapper around gtk_widget_show/hide so * This routine is merely a wrapper around gtk_widget_show/hide so
* that those functions can be called on a list of widgets. * that those functions can be called on a list of widgets.
@ -121,8 +121,8 @@ gnc_mdi_widget_show(gpointer data, gpointer user_data)
/** /**
* gnc_mdi_widget_sensitive * gnc_mdi_widget_sensitive
* *
* @par1: The widget to modify. * @data: The widget to modify.
* @par2: The new sensitivity of the widget. * @user_data: The new sensitivity of the widget.
* *
* This routine is merely a wrapper around gtk_widget_set_sensitive * This routine is merely a wrapper around gtk_widget_set_sensitive
* so that functions can be called on a list of widgets. * so that functions can be called on a list of widgets.
@ -139,10 +139,10 @@ gnc_mdi_widget_sensitive(gpointer data, gpointer user_data)
/** /**
* gnc_mdi_update_widgets * gnc_mdi_update_widgets
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* being brought to the front (or sent to the back). * being brought to the front (or sent to the back).
* *
* @par2: TRUE if this child is being raised to the front of the * @topmost: TRUE if this child is being raised to the front of the
* notebook (or to be the topmost window.) * notebook (or to be the topmost window.)
* *
* This routine performs all the widget modifications needed to adjust * This routine performs all the widget modifications needed to adjust
@ -166,10 +166,10 @@ gnc_mdi_update_widgets(GNCMDIChildInfo *mc, gboolean topmost)
/** /**
* gnc_mdi_child_find_menu_item * gnc_mdi_child_find_menu_item
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* currently visible. * currently visible.
* *
* @par2: A string giving the menu path of the item wanted. This * @path: A string giving the menu path of the item wanted. This
* string MUST NOT be internationalized. * string MUST NOT be internationalized.
* *
* This routine will search through the menubar looking for a specific * This routine will search through the menubar looking for a specific
@ -209,10 +209,10 @@ gnc_mdi_child_find_menu_item(GNCMDIChildInfo *mc, gchar *path)
/** /**
* gnc_mdi_child_find_toolbar_item * gnc_mdi_child_find_toolbar_item
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* currently visible. * currently visible.
* *
* @par2: A string giving the name the item wanted. This name MUST * @name: A string giving the name the item wanted. This name MUST
* NOT be internationalized. * NOT be internationalized.
* *
* This routine will search through the toolbar looking for a specific * This routine will search through the toolbar looking for a specific
@ -250,15 +250,15 @@ gnc_mdi_child_find_toolbar_item(GNCMDIChildInfo *mc, gchar *name)
/** /**
* gnc_mdi_child_auto_menu * gnc_mdi_child_auto_menu
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* whose menus should be set up for automatic adjustment. * whose menus should be set up for automatic adjustment.
* *
* @par2: An enum describing what should be done with this item each * @type: An enum describing what should be done with this item each
* time this child is brought to the front. Choices are: SHOW, HIDE, * time this child is brought to the front. Choices are: SHOW, HIDE,
* ENABLE, and DISABLE. * ENABLE, and DISABLE.
* *
* @par3: NULL terminated list of strings corresponding to the menu * @first_path: NULL terminated list of strings corresponding to the
* items that should be added to the adjustment list. * menu items that should be added to the adjustment list.
* *
* This routine searches through the application menu data structures * This routine searches through the application menu data structures
* to find the specified menu item widgets, and then adds them to a * to find the specified menu item widgets, and then adds them to a
@ -315,15 +315,15 @@ gnc_mdi_child_auto_menu(GNCMDIChildInfo *mc,
/** /**
* gnc_mdi_child_auto_toolbar * gnc_mdi_child_auto_toolbar
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* whose toolbar items should be set up for automatic adjustment. * whose toolbar items should be set up for automatic adjustment.
* *
* @par2: An enum describing what should be done with this item each * @type: An enum describing what should be done with this item each
* time this child is brought to the front. Choices are: SHOW, HIDE, * time this child is brought to the front. Choices are: SHOW, HIDE,
* ENABLE, and DISABLE. * ENABLE, and DISABLE.
* *
* @par3: NULL terminated list of strings corresponding to the toolbar * @first_path: NULL terminated list of strings corresponding to the
* items that should be added to the adjustment list. * toolbar items that should be added to the adjustment list.
* *
* This routine searches through the application toolbar data structures * This routine searches through the application toolbar data structures
* to find the specified toolbar item widgets, and then adds them to a * to find the specified toolbar item widgets, and then adds them to a
@ -387,7 +387,7 @@ gnc_mdi_child_auto_toolbar(GNCMDIChildInfo *mc,
/** /**
* gnc_mdi_show_toolbar * gnc_mdi_show_toolbar
* *
* @par1: A pointer to the child data structure for the GNC child * @mc: A pointer to the child data structure for the GNC child
* whose toolbar items should be shown/hidden. * whose toolbar items should be shown/hidden.
* *
* This routine shows or hides the gnome dock item containing the * This routine shows or hides the gnome dock item containing the
@ -437,11 +437,11 @@ gnc_mdi_child_set_title (GNCMDIChildInfo *childwin)
/** /**
* gnc_mdi_app_destroyed_cb * gnc_mdi_app_destroyed_cb
* *
* @par1: A pointer to the GnomeApp data structure being destroyed. * @app: A pointer to the GnomeApp data structure being destroyed.
* *
* @par2: A pointer to a GNCMDIInfo data structure associated with * @user_data: A pointer to a GNCMDIInfo data structure associated
* this GnomeMDI data structure. This value comes from the callback * with this GnomeMDI data structure. This value comes from the
* registration. * callback registration.
* *
* This function is called during destruction of the gnome app data * This function is called during destruction of the gnome app data
* structure. Its purpose is to save the toolbar settings and * structure. Its purpose is to save the toolbar settings and
@ -502,9 +502,9 @@ gnc_mdi_app_created_cb (GnomeMDI * mdi, GnomeApp * app, gpointer data)
/** /**
* gnc_mdi_destroy_cb * gnc_mdi_destroy_cb
* *
* @par1: A pointer to the GnomeMDI data structure being destroyed. * @w: A pointer to the GnomeMDI data structure being destroyed.
* *
* @par2: A pointer to a GNCMDIInfo data structure associated with * @data: A pointer to a GNCMDIInfo data structure associated with
* this GnomeMDI data structure. This value comes from the callback * this GnomeMDI data structure. This value comes from the callback
* registration. * registration.
* *
@ -534,7 +534,7 @@ gnc_mdi_destroy_cb (GtkObject * w, gpointer data)
/** /**
* gnc_mdi_child_menu_tweaking * gnc_mdi_child_menu_tweaking
* *
* @par1: A pointer to the child data structure for the GNC child view * @mc: A pointer to the child data structure for the GNC child view
* that has just been created. * that has just been created.
* *
* This routine adjust the main menubar to reflect which of the * This routine adjust the main menubar to reflect which of the
@ -563,14 +563,14 @@ gnc_mdi_child_menu_tweaking (GNCMDIChildInfo * mc)
/** /**
* gnc_mdi_child_menu_tweaking * gnc_mdi_child_menu_tweaking
* *
* @par1: A pointer to the child data structure for the GNC child view * @mc: A pointer to the child data structure for the GNC child view
* that should be updated. * that should be updated.
* *
* @par2: The dispatch entry whose data should be set. * @type: The dispatch entry whose data should be set.
* *
* @par3: A view specific callback function. * @cb: A view specific callback function.
* *
* @par4: The data to pass to the view specific callback. * @data: The data to pass to the view specific callback.
* *
* This routine remembers the data for dispatching various top level * This routine remembers the data for dispatching various top level
* menu items to view specific functions. These are items like the * menu items to view specific functions. These are items like the
@ -967,7 +967,7 @@ gnc_app_set_title (GnomeApp *app)
/** /**
* gnc_mdi_destroy * gnc_mdi_destroy
* *
* @par1: A pointer to a GNCMDIInfo data structure to destroy. * @gnc_mdi: A pointer to a GNCMDIInfo data structure to destroy.
* *
* This function is called during the destruction of the gnucash gui. * This function is called during the destruction of the gnucash gui.
* It is called from gnc_gui_destroy() in top-level.c * It is called from gnc_gui_destroy() in top-level.c

6
src/gnome/dialog-price-edit-db.c
View File

@ -415,9 +415,9 @@ get_quotes_clicked (GtkWidget *widget, gpointer data)
/** /**
* gnc_prices_click_column_cb * gnc_prices_click_column_cb
* *
* @par1: A pointer to the clist. * @clist: A pointer to the clist.
* @par2: The column number clicked (0 based). * @column: The column number clicked (0 based).
* @par3: A pointer to the data structure describing this window. * @data: A pointer to the data structure describing this window.
* *
* This function checks for a valid column number, and determines * This function checks for a valid column number, and determines
* whether or not to invert the current sort or select a new column * whether or not to invert the current sort or select a new column

21
src/gnome/window-acct-tree.c
View File

@ -79,10 +79,11 @@ static void gnc_acct_tree_tweak_menu (GNCMDIChildInfo * mc);
/** /**
* gnc_acct_tree_window_set_sensitives * gnc_acct_tree_window_set_sensitives
* *
* @par1: A pointer to the data structure holding all the data * @win: A pointer to the data structure holding all the data
* associated with the Account Tree window. * associated with the Account Tree window.
* *
* @par2: TRUE to enable the list of widgets, FALSE to disable them. * @sensitive: TRUE to enable the list of widgets, FALSE to disable
* them.
* *
* Run the list of account sensitive widgets and enable/disable all * Run the list of account sensitive widgets and enable/disable all
* the items in the list. * the items in the list.
@ -99,10 +100,10 @@ gnc_acct_tree_window_set_sensitives(GNCAcctTreeWin * win,
/** /**
* gnc_acct_tree_window_add_sensitive * gnc_acct_tree_window_add_sensitive
* *
* @par1: A pointer to the data structure holding all the data * @win: A pointer to the data structure holding all the data
* associated with the Account Tree window. * associated with the Account Tree window.
* *
* @par2: A pointer to a menu or toolbar item. * @widget: A pointer to a menu or toolbar item.
* *
* Add this widget to the list of items to be enabled/disabled when an * Add this widget to the list of items to be enabled/disabled when an
* account is selected in this window. * account is selected in this window.
@ -118,12 +119,12 @@ gnc_acct_tree_window_add_sensitive(GNCAcctTreeWin * win, GtkWidget *widget)
/** /**
* gnc_acct_tree_window_find_popup_item * gnc_acct_tree_window_find_popup_item
* *
* @par1: A pointer to the data structure holding all the data * @win: A pointer to the data structure holding all the data
* associated with the Account Tree window. * associated with the Account Tree window.
* *
* @par2: A pointer to the popup menu for this window. * @popup: A pointer to the popup menu for this window.
* *
* @par3: The name of the menu item to find. * @name: The name of the menu item to find.
* *
* This routine looks for a particular menu item in a popup menu. If * This routine looks for a particular menu item in a popup menu. If
* found, it adds the menu to the list of items to be enabled/disabled * found, it adds the menu to the list of items to be enabled/disabled
@ -898,10 +899,10 @@ static GnomeUIInfo scrubmenu[] =
/** /**
* gnc_acct_tree_window_create_menu * gnc_acct_tree_window_create_menu
* *
* @par1: A pointer to the data structure holding all the data * @main_info: A pointer to the data structure holding all the data
* associated with the Account Tree window. * associated with the Account Tree window.
* *
* @par2: A pointer to the GNC MDI child associated with the Account * @child: A pointer to the GNC MDI child associated with the Account
* Tree window. * Tree window.
* *
* This routine creates the menu for the right-click popup menu in the * This routine creates the menu for the right-click popup menu in the
@ -1208,7 +1209,7 @@ gnc_acct_tree_window_toolbar_options_cb(GtkWidget * widget, gpointer data) {
/** /**
* gnc_acct_tree_tweak_menu * gnc_acct_tree_tweak_menu
* *
* @par1: A pointer to the GNC MDI child associated with the Account * @mc: A pointer to the GNC MDI child associated with the Account
* Tree window. * Tree window.
* *
* This routine is called when the account tree view is created and * This routine is called when the account tree view is created and

22
src/gnome/window-main.c
View File

@ -255,7 +255,7 @@ gnc_main_window_can_restore_cb (const char * filename)
/** /**
* gnc_main_window_tweak_menus * gnc_main_window_tweak_menus
* *
* @par1: A pointer to the GNC MDI child associated with the Main * @mc: A pointer to the GNC MDI child associated with the Main
* window. * window.
* *
* This routine tweaks the View window in the main window menubar so * This routine tweaks the View window in the main window menubar so
@ -285,8 +285,8 @@ gnc_main_window_tweak_menus(GNCMDIChildInfo * mc)
/** /**
* gnc_main_window_flip_toolbar_cb * gnc_main_window_flip_toolbar_cb
* *
* @par1: A pointer to the menu item selected. (ignored) * @widget: A pointer to the menu item selected. (ignored)
* @par2: The user data for this menu item. (ignored) * @data: The user data for this menu item. (ignored)
* *
* This routine flips the state of the toolbar, hiding it if currently * This routine flips the state of the toolbar, hiding it if currently
* visible, and showing it if not. This routine has to grovel through * visible, and showing it if not. This routine has to grovel through
@ -321,8 +321,8 @@ gnc_main_window_flip_toolbar_cb(GtkWidget * widget, gpointer data)
/** /**
* gnc_main_window_flip_status_bar_cb * gnc_main_window_flip_status_bar_cb
* *
* @par1: A pointer to the menu item selected. (ignored) * @widget: A pointer to the menu item selected. (ignored)
* @par2: The user data for this menu item. (ignored) * @data: The user data for this menu item. (ignored)
* *
* This routine flips the state of the status bar, hiding it if * This routine flips the state of the status bar, hiding it if
* currently visible, and showing it if not. This routine has to * currently visible, and showing it if not. This routine has to
@ -363,8 +363,8 @@ gnc_main_window_flip_status_bar_cb(GtkWidget * widget, gpointer data)
/** /**
* gnc_main_window_flip_summary_bar_cb * gnc_main_window_flip_summary_bar_cb
* *
* @par1: A pointer to the menu item selected. (ignored) * @widget: A pointer to the menu item selected. (ignored)
* @par2: The user data for this menu item. (ignored) * @data: The user data for this menu item. (ignored)
* *
* This routine flips the state of the summary bar, hiding it if * This routine flips the state of the summary bar, hiding it if
* currently visible, and showing it if not. This routine has to * currently visible, and showing it if not. This routine has to
@ -596,8 +596,8 @@ gnc_main_window_file_shutdown_cb(GtkWidget * widget, gpointer data)
/** /**
* gnc_main_window_dispatch_cb * gnc_main_window_dispatch_cb
* *
* @par1: A pointer to the menu item selected. (ignored) * @widget: A pointer to the menu item selected. (ignored)
* @par2: The user data for this menu item. (ignored) * @data: The user data for this menu item. (ignored)
* *
* The main menubar has several items that must react differently * The main menubar has several items that must react differently
* depending upon what window is in front when they are selected. * depending upon what window is in front when they are selected.
@ -632,8 +632,8 @@ gnc_main_window_dispatch_cb(GtkWidget * widget, gpointer data)
/** /**
* gnc_main_window_tax_info_cb * gnc_main_window_tax_info_cb
* *
* @par1: A pointer to the menu item selected. (ignored) * @widget: A pointer to the menu item selected. (ignored)
* @par2: The user data for this menu item. (ignored) * @unused: The user data for this menu item. (ignored)
* *
* Bring up the window for editing tax data. * Bring up the window for editing tax data.
*/ */