[Gnucash-changes] Fix a bunch of warnings generated by doxygen.
David Hampton
hampton at cvs.gnucash.org
Thu Sep 29 21:37:44 EDT 2005
Log Message:
-----------
Fix a bunch of warnings generated by doxygen.
Tags:
----
gnucash-gnome2-dev
Modified Files:
--------------
gnucash:
ChangeLog
gnucash/src/backend/file:
io-gncxml-v2.h
gnucash/src/business/business-gnome:
gnc-plugin-page-invoice.h
gnucash/src/core-utils:
gnc-gconf-utils.h
gnucash/src/engine:
SchedXaction.h
TransLog.h
Transaction.h
gnc-commodity.h
gnc-pricedb.c
qofbackend-p.h
gnucash/src/gnome:
dialog-sx-from-trans.c
druid-merge.h
druid-stock-split.c
gnc-plugin-page-register.h
gnc-split-reg.c
window-main-summarybar.c
gnucash/src/gnome-utils:
dialog-account.h
dialog-commodity.c
dialog-preferences.c
dialog-preferences.h
druid-gconf-setup.c
druid-gconf-setup.h
gnc-date-edit.h
gnc-dense-cal.c
gnc-embedded-window.h
gnc-gnome-utils.h
gnc-main-window.c
gnc-main-window.h
gnc-plugin-manager.h
gnc-plugin-menu-additions.c
gnc-plugin-page.c
gnc-plugin-page.h
gnc-plugin.c
gnc-tree-model-commodity.h
gnc-tree-model-price.h
gnc-tree-view-account.h
gnc-tree-view-commodity.h
gnc-tree-view-price.h
gnc-tree-view.c
print-session.h
gnucash/src/import-export:
import-settings.h
gnucash/src/register/register-core:
combocell.h
Revision Data
-------------
Index: ChangeLog
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/ChangeLog,v
retrieving revision 1.1487.2.294
retrieving revision 1.1487.2.295
diff -LChangeLog -LChangeLog -u -r1.1487.2.294 -r1.1487.2.295
--- ChangeLog
+++ ChangeLog
@@ -1,3 +1,7 @@
+2005-09-29 David Hampton <hampton at employees.org>
+
+ * various: Fix a bunch of warnings generated by doxygen.
+
2005-09-26 David Hampton <hampton at employees.org>
* src/gnome-utils/gnc-plugin-page.c: Use the right data structure
Index: gnc-plugin-page-invoice.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/business/business-gnome/Attic/gnc-plugin-page-invoice.h,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/business/business-gnome/gnc-plugin-page-invoice.h -Lsrc/business/business-gnome/gnc-plugin-page-invoice.h -u -r1.1.2.2 -r1.1.2.3
--- src/business/business-gnome/gnc-plugin-page-invoice.h
+++ src/business/business-gnome/gnc-plugin-page-invoice.h
@@ -25,7 +25,7 @@
@{ */
/** @addtogroup InvoicePlugin Business Invoice Page
@{ */
-/** @file gnc-plugin-register-tree.h
+/** @file gnc-plugin-page-invoice.h
@brief utility functions for the GnuCash UI
@author Copyright (C) 2005 David Hampton <hampton at employees.org>
*/
@@ -66,27 +66,43 @@
/* function prototypes */
-/** Retrieve the type number for an "account tree" plugin page.
+/** Retrieve the type number for an "invoice" plugin page.
*
* @return The type number.
*/
GType gnc_plugin_page_invoice_get_type (void);
-/** Create a new "register" plugin page, given a pointer to an
- * account.
+/** Create a new "invoice" plugin page, given a pointer to an
+ * InvoiceWindow data structure. This structure is used to describe
+ * both the "invoice entry" page in a window, and also to describe
+ * the New Invoice dialog.
*
- * @param account The pointer to the account to embed in the
- * register.
- *
- * @param subaccounts TRUE if all the sub-accounts of the specified
- * account should be included in the register.
+ * @param iw A pointer to the invoice to be embedded into a main window.
*
* @return The newly created plugin page.
*/
GncPluginPage *gnc_plugin_page_invoice_new (InvoiceWindow *iw);
+
+/** Update the menu items associated with this invoice page. This
+ * function should be called whenever the posted state of an invoice
+ * is changed.
+ *
+ * @param page A pointer invoice page.
+ *
+ * @param is_posted Set this to TRUE if the invoice has been posted.
+ *
+ * @param can_unpost Set this to TRUE if the invoice can be un-posted.
+ */
void gnc_plugin_page_invoice_update_menus (GncPluginPage *page, gboolean is_posted, gboolean can_unpost);
+
+
+/** Update the title associated with this invoice page. This function
+ * should be called whenever the name on an invoice is changed.
+ *
+ * @param page A pointer invoice page.
+ */
void gnc_plugin_page_invoice_update_title (GncPluginPage *page);
G_END_DECLS
Index: gnc-gconf-utils.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/core-utils/Attic/gnc-gconf-utils.h,v
retrieving revision 1.1.2.12
retrieving revision 1.1.2.13
diff -Lsrc/core-utils/gnc-gconf-utils.h -Lsrc/core-utils/gnc-gconf-utils.h -u -r1.1.2.12 -r1.1.2.13
--- src/core-utils/gnc-gconf-utils.h
+++ src/core-utils/gnc-gconf-utils.h
@@ -94,9 +94,9 @@
* @param name The textual name for one of the items in the enum.
* For example, "ascending".
*
- * @param value A value contained in the enum. This value will be
- * returned if the supplied nickname is invalid. For example,
- * GTK_SORT_ASCENDING.
+ * @param default_value A value contained in the enum. This value
+ * will be returned if the supplied nickname is invalid. For
+ * example, GTK_SORT_ASCENDING.
*
* @return A pointer to the textual "nickname" for this enum.
*/
@@ -112,8 +112,9 @@
* qualified (i.e. begins with a '/' character), this routine does
* not change the key.
*
- * @param A partial gconf key or section name. This name is added to
- * the standard prefix to produce a fully qualified key name.
+ * @param name A partial gconf key or section name. This name is
+ * added to the standard prefix to produce a fully qualified key
+ * name.
*
* @return This function returns a string pointer to the fully
* qualified path name of the gconf key. It is the caller's
@@ -130,9 +131,9 @@
* key is already fully qualified (i.e. begins with the string
* "/schemas), this routine does not change the key.
*
- * @param A partial gconf schema key or section name. This name is
- * added to the standard schema prefix to produce a fully qualified
- * schema key name.
+ * @param name A partial gconf schema key or section name. This name
+ * is added to the standard schema prefix to produce a fully
+ * qualified schema key name.
*
* @return This function returns a string pointer to the fully
* qualified path name of the gconf schema key. It is the caller's
@@ -219,10 +220,7 @@
* func and user_data arguments are used to match up the callback to
* remove.
*
- * @param key This value contains the name of the key within the
- * "general" section to watch.
- *
- * @param func This is a pointer to the function to call when the key
+ * @param func This is a pointer to the function to call when a key
* changes.
*
* @param user_data This pointer will be passed to the callback
@@ -483,10 +481,11 @@
* @param name This string is the name of the particular key within
* the named section of gconf.
*
- * @param error An optional pointer to a GError structure. If NULL,
- * this function will check for any errors returned by GConf and will
- * display an error message via stdout. If present, this function
- * will pass any error back to the calling function for it to handle.
+ * @param caller_error An optional pointer to a GError structure. If
+ * NULL, this function will check for any errors returned by GConf
+ * and will display an error message via stdout. If present, this
+ * function will pass any error back to the calling function for it
+ * to handle.
*
* @return This function returns the schema stored at the requested
* key in the gconf database. If there is an error in processing,
@@ -495,7 +494,7 @@
* calling the gconf_schema_free() function.
*/
GConfSchema *gnc_gconf_get_schema (const gchar *section,
- const gchar *name,
+ const gchar *name,
GError **caller_error);
/** @} */
@@ -811,6 +810,11 @@
* same string provided when the callback function was added. This
* name is used to find/remove the callback.
*
+ * @param object This is a pointer to a GObject derivative. This
+ * must be the same object originally passed to the
+ * gnc_gconf_add_notification() function, as that function attached
+ * several values to the object that are needed by this function.
+ *
* @param section This string is used to find the correct
* notification function to remove from GConf.
*/
Index: SchedXaction.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/SchedXaction.h,v
retrieving revision 1.24.4.4
retrieving revision 1.24.4.5
diff -Lsrc/engine/SchedXaction.h -Lsrc/engine/SchedXaction.h -u -r1.24.4.4 -r1.24.4.5
--- src/engine/SchedXaction.h
+++ src/engine/SchedXaction.h
@@ -104,11 +104,12 @@
void xaccSchedXactionSetRemOccur( SchedXaction *sx, gint numRemain );
/** \brief Set the instance count.
-
+ *
* This is incremented by one for every created
* instance of the SX. Returns the instance num of the SX unless stateData
* is non-null, in which case it returns the instance num from the state
* data.
+ * @param sx The instance whose state should be retrieved.
* @param stateData may be NULL.
*/
gint gnc_sx_get_instance_count( SchedXaction *sx, void *stateData );
Index: Transaction.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/Transaction.h,v
retrieving revision 1.141.4.11
retrieving revision 1.141.4.12
diff -Lsrc/engine/Transaction.h -Lsrc/engine/Transaction.h -u -r1.141.4.11 -r1.141.4.12
--- src/engine/Transaction.h
+++ src/engine/Transaction.h
@@ -234,11 +234,11 @@
/** Set the Transaction Type
*
- * See #define TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT */
+ * See #TXN_TYPE_NONE, #TXN_TYPE_INVOICE and #TXN_TYPE_PAYMENT */
void xaccTransSetTxnType (Transaction *trans, char type);
/** Returns the Transaction Type
*
- * See #define TXN_TYPE_NONE, TXN_TYPE_INVOICE and TXN_TYPE_PAYMENT */
+ * See #TXN_TYPE_NONE, #TXN_TYPE_INVOICE and #TXN_TYPE_PAYMENT */
char xaccTransGetTxnType (const Transaction *trans);
@@ -868,7 +868,7 @@
/** Returns the time that a transaction was voided.
*
- * @param split The transaction in question.
+ * @param tr The transaction in question.
*
* @return A Timespec containing the time that this transaction was
* voided. Returns a time of zero upon error.
Index: gnc-pricedb.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-pricedb.c,v
retrieving revision 1.48.4.9
retrieving revision 1.48.4.10
diff -Lsrc/engine/gnc-pricedb.c -Lsrc/engine/gnc-pricedb.c -u -r1.48.4.9 -r1.48.4.10
--- src/engine/gnc-pricedb.c
+++ src/engine/gnc-pricedb.c
@@ -991,7 +991,7 @@
/* ==================================================================== */
/* lookup/query functions */
-/** \todo Fix the backend lookup that relies on a #define */
+/** \todo Fix the backend lookup that relies on a \#define */
GNCPrice *
gnc_pricedb_lookup_latest(GNCPriceDB *db,
gnc_commodity *commodity,
Index: gnc-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/gnc-commodity.h,v
retrieving revision 1.20.4.7
retrieving revision 1.20.4.8
diff -Lsrc/engine/gnc-commodity.h -Lsrc/engine/gnc-commodity.h -u -r1.20.4.7 -r1.20.4.8
--- src/engine/gnc-commodity.h
+++ src/engine/gnc-commodity.h
@@ -158,7 +158,7 @@
* @return A pointer to the price quote source that has the specified
* type/index.
*/
-gnc_quote_source *gnc_quote_source_lookup_by_ti(QuoteSourceType type, gint i);
+gnc_quote_source *gnc_quote_source_lookup_by_ti(QuoteSourceType type, gint index);
/** Given a gnc_quote_source data structure, return the flag that
* indicates whether this particular quote source is supported by
@@ -235,6 +235,8 @@
* @note This function does not check to see if the commodity exists
* before adding a new commodity.
*
+ * @param book The book that the new commodity will belong to.
+ *
* @param fullname The complete name of this commodity. E.G. "Acme
* Systems, Inc."
*
@@ -410,8 +412,6 @@
* @param cm A pointer to a commodity data structure.
*
* @return A pointer to the price quote source for this commodity.
- * This string is owned by the engine and should not be freed by the
- * caller.
*/
gnc_quote_source* gnc_commodity_get_quote_source(const gnc_commodity *cm);
gnc_quote_source* gnc_commodity_get_default_quote_source(const gnc_commodity *cm);
@@ -517,9 +517,7 @@
*
* @param cm A pointer to a commodity data structure.
*
- * @return A pointer to the price quote source for this commodity.
- * This string belongs to the caller and will be duplicated by the
- * engine.
+ * @param src A pointer to the price quote source for this commodity.
*/
void gnc_commodity_set_quote_source(gnc_commodity *cm, gnc_quote_source *src);
@@ -530,7 +528,7 @@
*
* @param cm A pointer to a commodity data structure.
*
- * @return A pointer to the price quote timezone for this commodity.
+ * @param tz A pointer to the price quote timezone for this commodity.
* This string belongs to the caller and will be duplicated by the
* engine.
*/
@@ -566,7 +564,7 @@
/** Checks to see if the specified commodity namespace is the
* namespace for ISO 4217 currencies.
*
- * @param cm The string to check.
+ * @param namespace The string to check.
*
* @return TRUE if the string indicates an ISO currency, FALSE otherwise. */
gboolean gnc_commodity_namespace_is_iso(const char *namespace);
@@ -655,7 +653,9 @@
* etc. It also adds all of the ISO 4217 currencies to the commodity
* table.
*
- * @param table A pointer to the commodity table */
+ * @param table A pointer to the commodity table.
+ *
+ * @param book Unused. */
gboolean gnc_commodity_table_add_default_data(gnc_commodity_table *table, QofBook *book);
/** @} */
@@ -697,7 +697,7 @@
*
* @return 1 if the namespace exists. 0 if it doesn't exist, or the
* routine was passed a bad argument. */
-int gnc_commodity_table_has_namespace(const gnc_commodity_table * t,
+int gnc_commodity_table_has_namespace(const gnc_commodity_table * table,
const char * namespace);
/** Return a list of all namespaces in the commodity table. This
@@ -749,7 +749,7 @@
*
* @note This routine will destroy any commodities that exist as part
* of this namespace. Use it carefully. */
-void gnc_commodity_table_delete_namespace(gnc_commodity_table * t,
+void gnc_commodity_table_delete_namespace(gnc_commodity_table * table,
const char * namespace);
/** @} */
/* ---------------------------------------------------------- */
@@ -759,7 +759,7 @@
/** Returns the number of commodities in the commodity table.
*
- * @param table A pointer to the commodity table
+ * @param tbl A pointer to the commodity table
*
* @return The number of commodities in the table. 0 if there are no
* commodities, or the routine was passed a bad argument. */
@@ -768,6 +768,8 @@
/** Return a list of all commodities in the commodity table that are
* in the given namespace.
*
+ * @param table A pointer to the commodity table
+ *
* @param namespace A string indicating which commodities should be
* returned. It is a required argument.
*
@@ -775,7 +777,7 @@
* argument was supplied, or the namespace could not be found.
*
* @note It is the callers responsibility to free the list. */
-GList * gnc_commodity_table_get_commodities(const gnc_commodity_table * t,
+GList * gnc_commodity_table_get_commodities(const gnc_commodity_table * table,
const char * namespace);
/** This function returns a list of commodities for which price quotes
Index: qofbackend-p.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/qofbackend-p.h,v
retrieving revision 1.2.4.6
retrieving revision 1.2.4.7
diff -Lsrc/engine/qofbackend-p.h -Lsrc/engine/qofbackend-p.h -u -r1.2.4.6 -r1.2.4.7
--- src/engine/qofbackend-p.h
+++ src/engine/qofbackend-p.h
@@ -285,7 +285,7 @@
so each one is passed the path to the data (e.g. a file) and
should return TRUE only:
-# if the backend recognises the type as one that it can load and write or
--#if the path contains no data but can be used (e.g. a new session).
+-# if the path contains no data but can be used (e.g. a new session).
\note If the backend can cope with more than one type, the backend
should not try to store or cache the sub-type for this data.
Index: TransLog.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/engine/TransLog.h,v
retrieving revision 1.9.6.2
retrieving revision 1.9.6.3
diff -Lsrc/engine/TransLog.h -Lsrc/engine/TransLog.h -u -r1.9.6.2 -r1.9.6.3
--- src/engine/TransLog.h
+++ src/engine/TransLog.h
@@ -51,7 +51,8 @@
void xaccOpenLog (void);
void xaccCloseLog (void);
/**
- \param char The engine currently uses the log mechanism with flag char set as
+ * @param trans The transaction to write out to the log
+ * @param flag The engine currently uses the log mechanism with flag char set as
* follows:
* 'B' for 'begin edit' (followed by the transaction as it looks
* before any changes, i.e. the 'old value')
@@ -62,7 +63,7 @@
* 'R' for rollback (i.e. revert to previous B; data that follows should
* be identical to old B)
*/
-void xaccTransWriteLog (Transaction *, char);
+void xaccTransWriteLog (Transaction *trans, char flag);
/** document me */
void xaccLogEnable (void);
Index: gnc-plugin-page.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-plugin-page.c,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -Lsrc/gnome-utils/gnc-plugin-page.c -Lsrc/gnome-utils/gnc-plugin-page.c -u -r1.1.2.7 -r1.1.2.8
--- src/gnome-utils/gnc-plugin-page.c
+++ src/gnome-utils/gnc-plugin-page.c
@@ -26,7 +26,7 @@
@{ */
/** @addtogroup ContentPluginBase Common object and functions
@{ */
-/** @file gnc-plugin-page.h
+/** @file gnc-plugin-page.c
@brief Functions for adding plugins to a Gnucash window.
@author Copyright (C) 2003 Jan Arne Petersen
@author Copyright (C) 2003,2005 David Hampton <hampton at employees.org>
Index: gnc-tree-model-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-commodity.h,v
retrieving revision 1.1.2.10
retrieving revision 1.1.2.11
diff -Lsrc/gnome-utils/gnc-tree-model-commodity.h -Lsrc/gnome-utils/gnc-tree-model-commodity.h -u -r1.1.2.10 -r1.1.2.11
--- src/gnome-utils/gnc-tree-model-commodity.h
+++ src/gnome-utils/gnc-tree-model-commodity.h
@@ -179,7 +179,7 @@
*
* @param model A pointer to the commodity tree model.
*
- * @param commodity A pointer to the gnucash commodity namespace.
+ * @param namespace A pointer to the gnucash commodity namespace.
*
* @param iter A pointer to a GtkTreeIter. This iter will be filled
* in to point where the namespace appears in the commodity tree.
@@ -193,7 +193,7 @@
*
* @param model A pointer to the commodity tree model.
*
- * @param namespace A pointer to the gnucash commodity.
+ * @param commodity A pointer to the gnucash commodity.
*
* @param iter A pointer to a GtkTreeIter. This iter will be filled
* in to point where the commodity appears in the commodity tree.
@@ -207,7 +207,7 @@
*
* @param model A pointer to the commodity tree model.
*
- * @param commodity A pointer to the gnucash commodity namespace.
+ * @param namespace A pointer to the gnucash commodity namespace.
*
* @return A pointer to a GtkTreePath describing the location of this
* namespace. This pointer must be freed by the caller when no
Index: gnc-tree-view-price.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-price.h,v
retrieving revision 1.1.2.6
retrieving revision 1.1.2.7
diff -Lsrc/gnome-utils/gnc-tree-view-price.h -Lsrc/gnome-utils/gnc-tree-view-price.h -u -r1.1.2.6 -r1.1.2.7
--- src/gnome-utils/gnc-tree-view-price.h
+++ src/gnome-utils/gnc-tree-view-price.h
@@ -108,8 +108,8 @@
*
* @param column_names A list of column names to make visible.
*/
-void gnc_tree_view_price_configure_columns (GncTreeViewPrice *price_view,
- GSList *column_names);
+void gnc_tree_view_price_configure_columns (GncTreeViewPrice *price_view,
+ GSList *column_names);
#ifdef OLD
/** Add a new column to the set of columns in an price tree view.
@@ -123,9 +123,9 @@
* price KVP structures. The value associated with this key is what
* will be displayed in the column.
*/
-void gnc_tree_view_price_add_kvp_column (GncTreeViewPrice *view,
- const gchar *column_title,
- const gchar *kvp_key);
+void gnc_tree_view_price_add_kvp_column (GncTreeViewPrice *view,
+ const gchar *column_title,
+ const gchar *kvp_key);
#endif
/** @} */
@@ -170,7 +170,7 @@
* @note This calls a function in gtk that is annotated in the
* sources as being slow. You have been warned.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*/
void gnc_tree_view_price_refilter (GncTreeViewPrice *view);
/** @} */
@@ -182,15 +182,15 @@
/** This function determines if an price in the price tree view
* has any visible children.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @param price A pointer to the price to check.
*
* @return The number of children of the specified price. Returns 0
* on error.
*/
-gint gnc_tree_view_price_count_children (GncTreeViewPrice *view,
- GNCPrice *price);
+gint gnc_tree_view_price_count_children (GncTreeViewPrice *view,
+ GNCPrice *price);
@@ -204,7 +204,7 @@
* path. This function is useful in selection callbacks on an
* price tree widget.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @param path A path specifying a node in the price tree.
*
@@ -218,7 +218,7 @@
* current location of the cursor. (The outline frame. Usually is
* selected and therefore filled in, but not always.)
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @return The price at the cursor.
*/
@@ -232,11 +232,11 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @return The selected price, or NULL if no price was selected.
*/
-GNCPrice * gnc_tree_view_price_get_selected_price (GncTreeViewPrice *view);
+GNCPrice * gnc_tree_view_price_get_selected_price (GncTreeViewPrice *view);
/** This function selects an price in the price tree view. All
@@ -250,12 +250,12 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @param price A pointer to the price to select.
*/
-void gnc_tree_view_price_set_selected_price (GncTreeViewPrice *view,
- GNCPrice *price);
+void gnc_tree_view_price_set_selected_price (GncTreeViewPrice *view,
+ GNCPrice *price);
/** This function returns a list of the prices associated with the
@@ -265,11 +265,11 @@
* tree is set to select multiple items. There is a different
* function to use when the tree supports single selection.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
* @return A list of prices, or NULL if no price was selected.
*/
-GList * gnc_tree_view_price_get_selected_prices (GncTreeViewPrice *view);
+GList * gnc_tree_view_price_get_selected_prices (GncTreeViewPrice *view);
/** This function selects a set of prices in the price tree view.
@@ -286,32 +286,16 @@
* @note It is the responsibility of the caller to free the returned
* list.
*
- * @param price_view A pointer to an price tree view.
+ * @param view A pointer to an price tree view.
*
- * @param price A pointer to the price to select.
+ * @param price_list A pointer to the list of prices to select.
*
* @param show_last Force the window to scroll to the last price
* selected.
*/
-void gnc_tree_view_price_set_selected_prices (GncTreeViewPrice *view,
- GList *price_list,
- gboolean show_last);
-
-
-/** This function selects all sub-prices of an price in the
- * price tree view. All other prices will be unselected.
- *
- * @note It only makes sense to call this function when the price
- * tree is set to select multiple items. There is a different
- * function to use when the tree supports multiple selections.
- *
- * @param price_view A pointer to an price tree view.
- *
- * @param price A pointer to the price whose children should be
- * selected.
- */
-void gnc_tree_view_price_select_subprices (GncTreeViewPrice *view,
- GNCPrice *price);
+void gnc_tree_view_price_set_selected_prices (GncTreeViewPrice *view,
+ GList *price_list,
+ gboolean show_last);
/** @} */
G_END_DECLS
Index: gnc-tree-model-price.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-model-price.h,v
retrieving revision 1.1.2.7
retrieving revision 1.1.2.8
diff -Lsrc/gnome-utils/gnc-tree-model-price.h -Lsrc/gnome-utils/gnc-tree-model-price.h -u -r1.1.2.7 -r1.1.2.8
--- src/gnome-utils/gnc-tree-model-price.h
+++ src/gnome-utils/gnc-tree-model-price.h
@@ -247,7 +247,7 @@
*
* @param model A pointer to the price tree model.
*
- * @param commodity A pointer to the gnucash commodity namespace.
+ * @param namespace A pointer to the gnucash commodity namespace.
*
* @return A pointer to a GtkTreePath describing the location of this
* namespace. This pointer must be freed by the caller when no
@@ -273,7 +273,7 @@
*
* @param model A pointer to the price tree model.
*
- * @param commodity A pointer to the gnucash commodity.
+ * @param price A pointer to the commodity price.
*
* @return A pointer to a GtkTreePath describing the location of this
* price. This pointer must be freed by the caller when no longer
Index: gnc-plugin.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-plugin.c,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -Lsrc/gnome-utils/gnc-plugin.c -Lsrc/gnome-utils/gnc-plugin.c -u -r1.1.2.4 -r1.1.2.5
--- src/gnome-utils/gnc-plugin.c
+++ src/gnome-utils/gnc-plugin.c
@@ -26,7 +26,7 @@
@{ */
/** @addtogroup MenuPluginBase Common object and functions
@{ */
-/** @file gnc-plugin.h
+/** @file gnc-plugin.c
@brief Functions for adding plugins to a Gnucash window.
@author Copyright (C) 2003 Jan Arne Petersen <jpetersen at uni-bonn.de>
@author Copyright (C) 2003,2005 David Hampton <hampton at employees.org>
@@ -413,3 +413,6 @@
}
}
#endif
+
+/** @} */
+/** @} */
Index: gnc-embedded-window.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-embedded-window.h,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome-utils/gnc-embedded-window.h -Lsrc/gnome-utils/gnc-embedded-window.h -u -r1.1.2.2 -r1.1.2.3
--- src/gnome-utils/gnc-embedded-window.h
+++ src/gnome-utils/gnc-embedded-window.h
@@ -67,14 +67,6 @@
GtkVBoxClass parent;
} GncEmbeddedWindowClass;
-typedef struct gnc_embedded_window {
- GtkUIManager *ui_merge;
- GtkActionGroup *action_group;
- GtkWidget *main_vbox;
- GtkWidget *menu_dock;
- GtkWidget *toolbar_dock;
-} gnc_embedded_window;
-
/* function prototypes */
GType gnc_embedded_window_get_type (void);
Index: dialog-preferences.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/dialog-preferences.h,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -Lsrc/gnome-utils/dialog-preferences.h -Lsrc/gnome-utils/dialog-preferences.h -u -r1.1.2.3 -r1.1.2.4
--- src/gnome-utils/dialog-preferences.h
+++ src/gnome-utils/dialog-preferences.h
@@ -101,3 +101,4 @@
#endif
/** @} */
+/** @} */
Index: gnc-date-edit.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/gnc-date-edit.h,v
retrieving revision 1.4.4.7
retrieving revision 1.4.4.8
diff -Lsrc/gnome-utils/gnc-date-edit.h -Lsrc/gnome-utils/gnc-date-edit.h -u -r1.4.4.7 -r1.4.4.8
--- src/gnome-utils/gnc-date-edit.h
+++ src/gnome-utils/gnc-date-edit.h
@@ -46,11 +46,13 @@
#define GNC_IS_DATE_EDIT(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, gnc_date_edit_get_type ())
/**
+ * \verbatim
* * 2001.05.13T1647 [PDT], #gnucash:
* <jsled> dave_p: So the header for gnc-dateedit.h is a bit light
* on _why_ such a thing was done... any help?
* <dave_p> jsled: gnome date edit isn't i18n'd properly. also, we
* added the register date hotkeys.
+ * \endverbatim
**/
typedef struct {
GtkHBox hbox;
Index: gnc-tree-view-commodity.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-commodity.h,v
retrieving revision 1.1.2.6
retrieving revision 1.1.2.7
diff -Lsrc/gnome-utils/gnc-tree-view-commodity.h -Lsrc/gnome-utils/gnc-tree-view-commodity.h -u -r1.1.2.6 -r1.1.2.7
--- src/gnome-utils/gnc-tree-view-commodity.h
+++ src/gnome-utils/gnc-tree-view-commodity.h
@@ -69,8 +69,8 @@
-/* Standard g_object type */
-GType gnc_tree_view_commodity_get_type (void);
+/* Get the GType for an GncTreeViewCommodity object. */
+GType gnc_tree_view_commodity_get_type (void);
/** @name Commodity Tree View Constructors
@@ -90,9 +90,9 @@
*
* @return A pointer to a new commodity tree view.
*/
-GtkTreeView *gnc_tree_view_commodity_new (QofBook *book,
- const gchar *first_property_name,
- ...);
+GtkTreeView *gnc_tree_view_commodity_new (QofBook *book,
+ const gchar *first_property_name,
+ ...);
/** @} */
@@ -104,12 +104,12 @@
* avalible list of columns can be found in the file
* gnc-tree-view-commodity.c
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @param column_names A list of column names to make visible.
*/
-void gnc_tree_view_commodity_configure_columns (GncTreeViewCommodity *commodity_view,
- GSList *column_names);
+void gnc_tree_view_commodity_configure_columns (GncTreeViewCommodity *view,
+ GSList *column_names);
#ifdef OLD
/** Add a new column to the set of columns in an commodity tree view.
@@ -123,9 +123,9 @@
* commodity KVP structures. The value associated with this key is what
* will be displayed in the column.
*/
-void gnc_tree_view_commodity_add_kvp_column (GncTreeViewCommodity *view,
- const gchar *column_title,
- const gchar *kvp_key);
+void gnc_tree_view_commodity_add_kvp_column (GncTreeViewCommodity *view,
+ const gchar *column_title,
+ const gchar *kvp_key);
#endif
/** @} */
@@ -133,6 +133,9 @@
/** @name Commodity Tree View Filtering
@{ */
+typedef gboolean (*gnc_tree_view_commodity_ns_filter_func)(gnc_commodity_namespace*, gpointer data);
+typedef gboolean (*gnc_tree_view_commodity_cm_filter_func)(gnc_commodity*, gpointer data);
+
/** This function attaches a filter function to the given commodity
* tree. This function will be called for each commodity that the view
* thinks should possibly show. The filter may perform any actions
@@ -140,11 +143,16 @@
* not. (I.E. Check type, placeholder status, etc.) If the filter
* returns TRUE then the commodity wil be displayed.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
- * @param func A filtration function that is called on individual
- * elements in the tree. If this function returns TRUE, the commodity
- * will be displayed.
+ * @param ns_func A filtration function that is called on individual
+ * tree elements that represent a namespace. If this function
+ * returns TRUE, the namespace (and commodities under it) will be
+ * displayed.
+ *
+ * @param cm_func A filtration function that is called on individual
+ * tree elements that represent a commodity. If this function
+ * returns TRUE, the commodity will be displayed.
*
* @param data A data block passed into each instance of the function.
*
@@ -152,8 +160,6 @@
* function will be called when the filter is destroyed. may be
* NULL.
*/
-typedef gboolean (*gnc_tree_view_commodity_ns_filter_func)(gnc_commodity_namespace*, gpointer data);
-typedef gboolean (*gnc_tree_view_commodity_cm_filter_func)(gnc_commodity*, gpointer data);
void gnc_tree_view_commodity_set_filter (GncTreeViewCommodity *view,
gnc_tree_view_commodity_ns_filter_func ns_func,
gnc_tree_view_commodity_cm_filter_func cm_func,
@@ -169,9 +175,9 @@
* @note This calls a function in gtk that is annotated in the
* sources as being slow. You have been warned.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*/
-void gnc_tree_view_commodity_refilter (GncTreeViewCommodity *view);
+void gnc_tree_view_commodity_refilter (GncTreeViewCommodity *view);
/** @} */
@@ -181,18 +187,30 @@
/** This function determines if an commodity in the commodity tree view
* has any visible children.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @param commodity A pointer to the commodity to check.
*
* @return The number of children of the specified commodity. Returns 0
* on error.
*/
-gint gnc_tree_view_commodity_count_children (GncTreeViewCommodity *view,
- gnc_commodity *commodity);
+gint gnc_tree_view_commodity_count_children (GncTreeViewCommodity *view,
+ gnc_commodity *commodity);
+/** This function retrieves a pointer to a commodity based upon the
+ * model and iter passed into it. It should only be used by callback
+ * functions that have had the model/iter passed to them.
+ *
+ * @param column A pointer to a tree view column from a commodity view.
+ *
+ * @param f_model A pointer to the filter model for the view.
+ *
+ * @param f_iter A pointer to the iter for a particular row in the view.
+ *
+ * @return The commodity associated with the spcified row in the view.
+ */
gnc_commodity * gnc_tree_view_commodity_get_commodity_from_column (GtkTreeViewColumn *column,
GtkTreeModel *f_model,
GtkTreeIter *f_iter);
@@ -203,7 +221,7 @@
* path. This function is useful in selection callbacks on an
* commodity tree widget.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @param path A path specifying a node in the commodity tree.
*
@@ -217,7 +235,7 @@
* current location of the cursor. (The outline frame. Usually is
* selected and therefore filled in, but not always.)
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @return The commodity at the cursor.
*/
@@ -231,7 +249,7 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @return The selected commodity, or NULL if no commodity was selected.
*/
@@ -249,12 +267,12 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @param commodity A pointer to the commodity to select.
*/
-void gnc_tree_view_commodity_set_selected_commodity (GncTreeViewCommodity *view,
- gnc_commodity *commodity);
+void gnc_tree_view_commodity_set_selected_commodity (GncTreeViewCommodity *view,
+ gnc_commodity *commodity);
/** This function returns a list of the commodities associated with the
@@ -264,11 +282,11 @@
* tree is set to select multiple items. There is a different
* function to use when the tree supports single selection.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @return A list of commodities, or NULL if no commodity was selected.
*/
-GList * gnc_tree_view_commodity_get_selected_commodities (GncTreeViewCommodity *view);
+GList * gnc_tree_view_commodity_get_selected_commodities (GncTreeViewCommodity *view);
/** This function selects a set of commodities in the commodity tree view.
@@ -285,16 +303,16 @@
* @note It is the responsibility of the caller to free the returned
* list.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
- * @param commodity A pointer to the commodity to select.
+ * @param commodity_list A list of commodities to select.
*
* @param show_last Force the window to scroll to the last commodity
* selected.
*/
-void gnc_tree_view_commodity_set_selected_commodities (GncTreeViewCommodity *view,
- GList *commodity_list,
- gboolean show_last);
+void gnc_tree_view_commodity_set_selected_commodities (GncTreeViewCommodity *view,
+ GList *commodity_list,
+ gboolean show_last);
/** This function selects all sub-commodities of an commodity in the
@@ -304,13 +322,13 @@
* tree is set to select multiple items. There is a different
* function to use when the tree supports multiple selections.
*
- * @param commodity_view A pointer to an commodity tree view.
+ * @param view A pointer to an commodity tree view.
*
* @param commodity A pointer to the commodity whose children should be
* selected.
*/
-void gnc_tree_view_commodity_select_subcommodities (GncTreeViewCommodity *view,
- gnc_commodity *commodity);
+void gnc_tree_view_commodity_select_subcommodities (GncTreeViewCommodity *view,
+ gnc_commodity *commodity);
/** @} */
Index: gnc-tree-view-account.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view-account.h,v
retrieving revision 1.1.2.14
retrieving revision 1.1.2.15
diff -Lsrc/gnome-utils/gnc-tree-view-account.h -Lsrc/gnome-utils/gnc-tree-view-account.h -u -r1.1.2.14 -r1.1.2.15
--- src/gnome-utils/gnc-tree-view-account.h
+++ src/gnome-utils/gnc-tree-view-account.h
@@ -76,8 +76,8 @@
-/* Standard g_object type */
-GType gnc_tree_view_account_get_type (void);
+/* Get the GType for an GncTreeViewAccount object. */
+GType gnc_tree_view_account_get_type (void);
/** @name Account Tree View Constructors
@@ -89,13 +89,29 @@
* but this code provides one so that it can be used with all parts
* of the gnucash gui.
*
+ * @param group A list of the accounts to use as the first level of
+ * accounts in the created tree. This list may not be NULL.
+ *
* @param show_root Show the pseudo top-level account in this view.
*
* @return A pointer to a new account tree view.
*/
GtkTreeView *gnc_tree_view_account_new_with_group (AccountGroup *group,
gboolean show_root);
+
+/** Create a new account tree view. This view may or may not show a
+ * pseudo top-level account. The gnucash engine does not have a
+ * single top level account (it has a list of top level accounts),
+ * but this code provides one so that it can be used with all parts
+ * of the gnucash gui. The first level of accounts in the created
+ * tree will be the top level of accounts in the current book.
+ *
+ * @param show_root Show the pseudo top-level account in this view.
+ *
+ * @return A pointer to a new account tree view.
+ */
GtkTreeView *gnc_tree_view_account_new (gboolean show_root);
+
/** @} */
@@ -111,9 +127,24 @@
const gchar *new_text);
-/* The TreeView owns the TreeViewColumn, but caller may set properties. */
+/** Add a new custom column to the set of columns in an account tree
+ * view. This column will be visible as soon as it is added and will
+ * query the provided functions to determine what data to display.
+ * The TreeView will own the resulting TreeViewColumn, but caller may
+ * set any additional properties they wish.
+ *
+ * @param view A pointer to an account tree view.
+ *
+ * @param column_title The title for this new column.
+ *
+ * @param source_cb A callback function that is expected to provide
+ * the data to be displayed.
+ *
+ * @param edited_cb A callback function that will be called if the
+ * user edits the displayed data.
+ */
GtkTreeViewColumn * gnc_tree_view_account_add_custom_column(
- GncTreeViewAccount *account_view, const gchar *column_title,
+ GncTreeViewAccount *view, const gchar *column_title,
GncTreeViewAccountColumnSource source_cb,
GncTreeViewAccountColumnTextEdited edited_cb);
@@ -131,9 +162,9 @@
* account KVP structures. The value associated with this key is what
* will be displayed in the column.
*/
-void gnc_tree_view_account_add_kvp_column (GncTreeViewAccount *view,
- const gchar *column_title,
- const gchar *kvp_key);
+void gnc_tree_view_account_add_kvp_column (GncTreeViewAccount *view,
+ const gchar *column_title,
+ const gchar *kvp_key);
/** @} */
@@ -168,6 +199,17 @@
AccountViewInfo *avi);
+/** This is the description of a filter function used by the account tree.
+ *
+ * @param account The account to be tested.
+ *
+ * @param data The data provided when the filter function was added.
+ *
+ * @return TRUE if the account should be displayed.
+ */
+typedef gboolean (*gnc_tree_view_account_filter_func)(Account *account, gpointer data);
+
+
/** This function attaches a filter function to the given account
* tree. This function will be called for each account that the view
* thinks should possibly show. The filter may perform any actions
@@ -187,7 +229,6 @@
* function will be called when the filter is destroyed. may be
* NULL.
*/
-typedef gboolean (*gnc_tree_view_account_filter_func)(Account*, gpointer data);
void gnc_tree_view_account_set_filter (GncTreeViewAccount *account_view,
gnc_tree_view_account_filter_func func,
gpointer data,
@@ -213,6 +254,7 @@
gboolean gnc_tree_view_account_filter_by_type_selection(
Account* acct, gpointer data);
+
/** This function forces the account tree filter to be evaluated. It
* may be necessary to call this function if the initial state of the
* view is incorrect. This appears to only be necessary if the
@@ -221,7 +263,7 @@
* @note This calls a function in gtk that is annotated in the
* sources as being slow. You have been warned.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*/
void gnc_tree_view_account_refilter (GncTreeViewAccount *view);
/** @} */
@@ -233,15 +275,15 @@
/** This function determines if an account in the account tree view
* has any visible children.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @param account A pointer to the account to check.
*
* @return The number of children of the specified account. Returns 0
* on error.
*/
-gint gnc_tree_view_account_count_children (GncTreeViewAccount *view,
- Account *account);
+gint gnc_tree_view_account_count_children (GncTreeViewAccount *view,
+ Account *account);
@@ -256,25 +298,25 @@
* the time this was written, only the "New/Edit Account" dialog does
* that.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @return The top-level pseudo-account.
*/
-Account * gnc_tree_view_account_get_top_level (GncTreeViewAccount *view);
+Account * gnc_tree_view_account_get_top_level (GncTreeViewAccount *view);
/** This function returns the account associated with the specified
* path. This function is useful in selection callbacks on an
* account tree widget.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @param path A path specifying a node in the account tree.
*
* @return The account associated with this path.
*/
-Account * gnc_tree_view_account_get_account_from_path (GncTreeViewAccount *view,
- GtkTreePath *path);
+Account * gnc_tree_view_account_get_account_from_path (GncTreeViewAccount *view,
+ GtkTreePath *path);
/** This function returns the account associated with the specified
@@ -287,19 +329,19 @@
*
* @return The account associated with this iter.
*/
-Account * gnc_tree_view_account_get_account_from_iter (GtkTreeModel *model,
- GtkTreeIter *iter);
+Account * gnc_tree_view_account_get_account_from_iter (GtkTreeModel *model,
+ GtkTreeIter *iter);
/** This function returns the account in the account tree view at the
* current location of the cursor. (The outline frame. Usually is
* selected and therefore filled in, but not always.)
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @return The account at the cursor.
*/
-Account * gnc_tree_view_account_get_cursor_account (GncTreeViewAccount *view);
+Account * gnc_tree_view_account_get_cursor_account (GncTreeViewAccount *view);
/** This function returns the account associated with the selected
@@ -309,11 +351,11 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @return The selected account, or NULL if no account was selected.
*/
-Account * gnc_tree_view_account_get_selected_account (GncTreeViewAccount *view);
+Account * gnc_tree_view_account_get_selected_account (GncTreeViewAccount *view);
/** This function selects an account in the account tree view. All
@@ -327,12 +369,12 @@
* tree is set to select a single item. There is a different
* function to use when the tree supports multiple selections.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @param account A pointer to the account to select.
*/
-void gnc_tree_view_account_set_selected_account (GncTreeViewAccount *view,
- Account *account);
+void gnc_tree_view_account_set_selected_account (GncTreeViewAccount *view,
+ Account *account);
/** This function returns a list of the accounts associated with the
@@ -342,11 +384,11 @@
* tree is set to select multiple items. There is a different
* function to use when the tree supports single selection.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @return A list of accounts, or NULL if no account was selected.
*/
-GList * gnc_tree_view_account_get_selected_accounts (GncTreeViewAccount *view);
+GList * gnc_tree_view_account_get_selected_accounts (GncTreeViewAccount *view);
/** This function selects a set of accounts in the account tree view.
@@ -363,16 +405,16 @@
* @note It is the responsibility of the caller to free the returned
* list.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
- * @param account A pointer to the account to select.
+ * @param account_list A list of accounts to select.
*
* @param show_last Force the window to scroll to the last account
* selected.
*/
-void gnc_tree_view_account_set_selected_accounts (GncTreeViewAccount *view,
- GList *account_list,
- gboolean show_last);
+void gnc_tree_view_account_set_selected_accounts (GncTreeViewAccount *view,
+ GList *account_list,
+ gboolean show_last);
/** This function selects all sub-accounts of an account in the
@@ -382,13 +424,13 @@
* tree is set to select multiple items. There is a different
* function to use when the tree supports multiple selections.
*
- * @param account_view A pointer to an account tree view.
+ * @param view A pointer to an account tree view.
*
* @param account A pointer to the account whose children should be
* selected.
*/
-void gnc_tree_view_account_select_subaccounts (GncTreeViewAccount *view,
- Account *account);
+void gnc_tree_view_account_select_subaccounts (GncTreeViewAccount *view,
+ Account *account);
/** @} */
Index: druid-gconf-setup.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/druid-gconf-setup.c,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -Lsrc/gnome-utils/druid-gconf-setup.c -Lsrc/gnome-utils/druid-gconf-setup.c -u -r1.1.2.4 -r1.1.2.5
--- src/gnome-utils/druid-gconf-setup.c
+++ src/gnome-utils/druid-gconf-setup.c
@@ -564,7 +564,7 @@
}
-/** This routine checks to see if GnuCash's gconf schemas are visible
+/* This routine checks to see if GnuCash's gconf schemas are visible
* to the user. The schemas typically should be visible, as rpm and
* deb installs will put the schemas in the default system location.
* For things like network installs or developers, this function will
@@ -618,3 +618,4 @@
}
/** @} */
+/** @} */
Index: gnc-main-window.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-main-window.h,v
retrieving revision 1.1.2.6
retrieving revision 1.1.2.7
diff -Lsrc/gnome-utils/gnc-main-window.h -Lsrc/gnome-utils/gnc-main-window.h -u -r1.1.2.6 -r1.1.2.7
--- src/gnome-utils/gnc-main-window.h
+++ src/gnome-utils/gnc-main-window.h
@@ -226,7 +226,7 @@
* @param window A pointer to the window whose user interface should
* be updated.
*
- * @comment Is this function still needed?
+ * @attention Is this function still needed?
*/
void gnc_main_window_actions_updated (GncMainWindow *window);
Index: gnc-tree-view.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-tree-view.c,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -Lsrc/gnome-utils/gnc-tree-view.c -Lsrc/gnome-utils/gnc-tree-view.c -u -r1.1.2.3 -r1.1.2.4
--- src/gnome-utils/gnc-tree-view.c
+++ src/gnome-utils/gnc-tree-view.c
@@ -89,7 +89,7 @@
/* This static indicates the debugging module that this .o belongs to. */
static short module = MOD_GUI;
-/** Declarations *********************************************************/
+/**** Declarations ******************************************************/
static void gnc_tree_view_class_init (GncTreeViewClass *klass);
static void gnc_tree_view_init (GncTreeView *view, GncTreeViewClass *klass);
static void gnc_tree_view_finalize (GObject *object);
Index: druid-gconf-setup.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/druid-gconf-setup.h,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -Lsrc/gnome-utils/druid-gconf-setup.h -Lsrc/gnome-utils/druid-gconf-setup.h -u -r1.1.2.2 -r1.1.2.3
--- src/gnome-utils/druid-gconf-setup.h
+++ src/gnome-utils/druid-gconf-setup.h
@@ -47,3 +47,4 @@
#endif
/** @} */
+/** @} */
Index: gnc-gnome-utils.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/gnc-gnome-utils.h,v
retrieving revision 1.1.4.9
retrieving revision 1.1.4.10
diff -Lsrc/gnome-utils/gnc-gnome-utils.h -Lsrc/gnome-utils/gnc-gnome-utils.h -u -r1.1.4.9 -r1.1.4.10
--- src/gnome-utils/gnc-gnome-utils.h
+++ src/gnome-utils/gnc-gnome-utils.h
@@ -152,3 +152,4 @@
#endif
/** @} */
+/** @} */
Index: gnc-main-window.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-main-window.c,v
retrieving revision 1.1.2.19
retrieving revision 1.1.2.20
diff -Lsrc/gnome-utils/gnc-main-window.c -Lsrc/gnome-utils/gnc-main-window.c -u -r1.1.2.19 -r1.1.2.20
--- src/gnome-utils/gnc-main-window.c
+++ src/gnome-utils/gnc-main-window.c
@@ -27,7 +27,7 @@
@{ */
/** @addtogroup GncMainWindow Main Window functions.
@{ */
-/** @file gnc-main-window.h
+/** @file gnc-main-window.c
@brief Functions for adding content to a window.
@author Copyright (C) 2003 Jan Arne Petersen <jpetersen at uni-bonn.de>
@author Copyright (C) 2003,2005 David Hampton <hampton at employees.org>
@@ -913,8 +913,8 @@
/**
* GncMainWindow::page_added:
- * @window: the #GncMainWindow
- * @page: the #GncPluginPage
+ * @param window: the #GncMainWindow
+ * @param page: the #GncPluginPage
*
* The "page_added" signal is emitted when a new page is added
* to the notebook of a GncMainWindow. This can be used to
@@ -934,8 +934,8 @@
/**
* GncMainWindow::page_changed:
- * @window: the #GncMainWindow
- * @page: the #GncPluginPage
+ * @param window: the #GncMainWindow
+ * @param page: the #GncPluginPage
*
* The "page_changed" signal is emitted when a new page is
* selected in the notebook of a GncMainWindow. This can be
Index: dialog-account.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/dialog-account.h,v
retrieving revision 1.1.4.3
retrieving revision 1.1.4.4
diff -Lsrc/gnome-utils/dialog-account.h -Lsrc/gnome-utils/dialog-account.h -u -r1.1.4.3 -r1.1.4.4
--- src/gnome-utils/dialog-account.h
+++ src/gnome-utils/dialog-account.h
@@ -48,7 +48,8 @@
/** Disply a window for editing the attributes of an existing account.
*
- * @param group This parameter is not used.
+ * @param account This parameter specifies the account whose data
+ * will be edited.
*/
void gnc_ui_edit_account_window (Account *account);
@@ -76,7 +77,7 @@
/** Disply a window for creating a new account. This function will
* restrict the available account type values to the list specified by the caller.
*
- * @param group This parameter is not used.
+ * @param unused This parameter is not used.
*
* @param valid_types A GList of GNCAccountType gints [as pointers]
* which are allowed to be created. The calling function is
@@ -93,7 +94,8 @@
/** Disply a modal window for creating a new account
*
- * @param group This parameter is not used.
+ * @param name The account name/path to be created. This parameter
+ * is not used for determining the initially selected parent account.
*/
Account * gnc_ui_new_accounts_from_name_window (const char *name);
Index: dialog-commodity.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/dialog-commodity.c,v
retrieving revision 1.8.4.14
retrieving revision 1.8.4.15
diff -Lsrc/gnome-utils/dialog-commodity.c -Lsrc/gnome-utils/dialog-commodity.c -u -r1.8.4.14 -r1.8.4.15
--- src/gnome-utils/dialog-commodity.c
+++ src/gnome-utils/dialog-commodity.c
@@ -281,7 +281,7 @@
* Commodity Selection dialog. It should not be used outside of the
* dialog-commodity.c file.
*
- * @param entry A pointer to the "new" button widget in the dialog.
+ * @param button A pointer to the "new" button widget in the dialog.
*
* @param user_data A pointer to the data structure describing the
* current state of the commodity picker.
@@ -1133,3 +1133,4 @@
}
/** @} */
+/** @} */
Index: gnc-dense-cal.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/gnc-dense-cal.c,v
retrieving revision 1.11.4.12
retrieving revision 1.11.4.13
diff -Lsrc/gnome-utils/gnc-dense-cal.c -Lsrc/gnome-utils/gnc-dense-cal.c -u -r1.11.4.12 -r1.11.4.13
--- src/gnome-utils/gnc-dense-cal.c
+++ src/gnome-utils/gnc-dense-cal.c
@@ -144,7 +144,7 @@
**/
static int num_weeks_per_col( GncDenseCal *dcal );
-/** hotspot calculation **/
+/* hotspot calculation */
static gint wheres_this( GncDenseCal *dcal, int x, int y );
static void recompute_x_y_scales( GncDenseCal *dcal );
Index: dialog-preferences.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/dialog-preferences.c,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -Lsrc/gnome-utils/dialog-preferences.c -Lsrc/gnome-utils/dialog-preferences.c -u -r1.1.2.8 -r1.1.2.9
--- src/gnome-utils/dialog-preferences.c
+++ src/gnome-utils/dialog-preferences.c
@@ -1305,3 +1305,4 @@
}
/** @} */
+/** @} */
Index: gnc-plugin-manager.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-plugin-manager.h,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -Lsrc/gnome-utils/gnc-plugin-manager.h -Lsrc/gnome-utils/gnc-plugin-manager.h -u -r1.1.2.3 -r1.1.2.4
--- src/gnome-utils/gnc-plugin-manager.h
+++ src/gnome-utils/gnc-plugin-manager.h
@@ -149,6 +149,8 @@
* @param manager A pointer to the plugin manager. Retrieve this by
* calling gnc_plugin_manager_get().
*
+ * @param name The name of the plugin to find.
+ *
* @return A pointer to the requested plugin, or NULL if the plugin
* couldn't be found.
*/
Index: print-session.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/print-session.h,v
retrieving revision 1.3.4.6
retrieving revision 1.3.4.7
diff -Lsrc/gnome-utils/print-session.h -Lsrc/gnome-utils/print-session.h -u -r1.3.4.6 -r1.3.4.7
--- src/gnome-utils/print-session.h
+++ src/gnome-utils/print-session.h
@@ -76,7 +76,7 @@
/** Destroy a print 'session' without producing any output.
*
- * @ps A pointer to the session to be destroyed.
+ * @param ps A pointer to the session to be destroyed.
*/
void gnc_print_session_destroy(PrintSession * ps);
@@ -84,14 +84,7 @@
/** Finish a print 'session'. The output from this session will be
* printed to the device selected when the session was created.
*
- * If the hand_built_pages argument was set to TRUE in the call to
- * #gnc_print_session_create, this function will perform the
- * additional setp of calling the gnome show page function before
- * doing anything else.
- *
- * @param hand_built_pages If TRUE, this funciton will perform extra setup.
- *
- * @return A pointer to the data structure describing this print session.
+ * @param ps A pointer to the session to be closed.
*/
void gnc_print_session_done(PrintSession * ps);
Index: gnc-plugin-menu-additions.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-plugin-menu-additions.c,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -Lsrc/gnome-utils/gnc-plugin-menu-additions.c -Lsrc/gnome-utils/gnc-plugin-menu-additions.c -u -r1.1.2.4 -r1.1.2.5
--- src/gnome-utils/gnc-plugin-menu-additions.c
+++ src/gnome-utils/gnc-plugin-menu-additions.c
@@ -370,3 +370,6 @@
LEAVE(" ");
}
+
+/** @} */
+/** @} */
Index: gnc-plugin-page.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome-utils/Attic/gnc-plugin-page.h,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -Lsrc/gnome-utils/gnc-plugin-page.h -Lsrc/gnome-utils/gnc-plugin-page.h -u -r1.1.2.5 -r1.1.2.6
--- src/gnome-utils/gnc-plugin-page.h
+++ src/gnome-utils/gnc-plugin-page.h
@@ -53,14 +53,23 @@
typedef struct GncPluginPagePrivate GncPluginPagePrivate;
typedef struct GncPluginPage {
- GObject parent;
- GncPluginPagePrivate *priv;
+ GObject parent; /**< The parent object data. */
+ GncPluginPagePrivate *priv; /**< Object private data. */
- /** These fields are semi-private. They should only be access by
- * the gnucash window management code. */
- GtkWidget *window;
- GtkWidget *notebook_page;
- GtkWidget *summarybar;
+ GtkWidget *window; /**< The window that contains the
+ * display widget for this plugin.
+ * This field is private to the
+ * gnucash window management
+ * code. */
+ GtkWidget *notebook_page; /**< The display widget for this
+ * plugin. This field is private to
+ * the gnucash window management
+ * code. */
+ GtkWidget *summarybar; /**< The summary bar widget (if any)
+ * that is associated with this
+ * plugin. This field is private to
+ * the gnucash window management
+ * code. */
} GncPluginPage;
typedef struct {
Index: import-settings.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/import-export/import-settings.h,v
retrieving revision 1.2.4.1
retrieving revision 1.2.4.2
diff -Lsrc/import-export/import-settings.h -Lsrc/import-export/import-settings.h -u -r1.2.4.1 -r1.2.4.2
--- src/import-export/import-settings.h
+++ src/import-export/import-settings.h
@@ -38,16 +38,7 @@
/** Allocates a new GNCImportSettings object, and initialize it with
* the appropriate user prefs.
- *
- * @param match_date_hardlimit The number of days that a matching
- * split may differ from the given transaction before it is discarded
- * immediately. In other words, any split that is more distant from
- * the given transaction than this match_date_hardlimit days will be
- * ignored altogether. For use cases without paper checks (e.g. HBCI),
- * values like 14 (days) might be appropriate, whereas for use cases
- * with paper checks (e.g. OFX, QIF), values like 42 (days) seem more
- * appropriate.
-*/
+ */
GNCImportSettings *
gnc_import_Settings_new (void);
Index: io-gncxml-v2.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/backend/file/io-gncxml-v2.h,v
retrieving revision 1.11.4.4
retrieving revision 1.11.4.5
diff -Lsrc/backend/file/io-gncxml-v2.h -Lsrc/backend/file/io-gncxml-v2.h -u -r1.11.4.4 -r1.11.4.5
--- src/backend/file/io-gncxml-v2.h
+++ src/backend/file/io-gncxml-v2.h
@@ -23,7 +23,7 @@
\********************************************************************/
/**
- * @file io-gncxml.h
+ * @file io-gncxml-v2.h
* @brief api for GnuCash version 2 XML-based file format
* @author Initial code by James LewisMoss, 2001
*/
Index: druid-stock-split.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/druid-stock-split.c,v
retrieving revision 1.34.4.10
retrieving revision 1.34.4.11
diff -Lsrc/gnome/druid-stock-split.c -Lsrc/gnome/druid-stock-split.c -u -r1.34.4.10 -r1.34.4.11
--- src/gnome/druid-stock-split.c
+++ src/gnome/druid-stock-split.c
@@ -96,7 +96,7 @@
void gnc_stock_split_druid_cancel_druid (GnomeDruid *druid,
gpointer user_data);
-/** implementations ****************************************************/
+/******* implementations ***********************************************/
void
gnc_stock_split_druid_window_destroy_cb (GtkObject *object, gpointer data)
{
Index: druid-merge.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/druid-merge.h,v
retrieving revision 1.2.2.2
retrieving revision 1.2.2.3
diff -Lsrc/gnome/druid-merge.h -Lsrc/gnome/druid-merge.h -u -r1.2.2.2 -r1.2.2.3
--- src/gnome/druid-merge.h
+++ src/gnome/druid-merge.h
@@ -69,7 +69,7 @@
any error values to the calling process.
@{ */
-/** @file druid_merge.h
+/** @file druid-merge.h
@brief API for merging two \c QofBook* structures with collision handling
@author Copyright (c) 2004 Neil Williams <linux at codehelp.co.uk>
*/
Index: dialog-sx-from-trans.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/dialog-sx-from-trans.c,v
retrieving revision 1.26.4.5
retrieving revision 1.26.4.6
diff -Lsrc/gnome/dialog-sx-from-trans.c -Lsrc/gnome/dialog-sx-from-trans.c -u -r1.26.4.5 -r1.26.4.6
--- src/gnome/dialog-sx-from-trans.c
+++ src/gnome/dialog-sx-from-trans.c
@@ -70,8 +70,6 @@
static short module = MOD_SX;
-/** start_date_edit, end_date_edit, param_table, end_date_hbox */
-
static void sxftd_freq_option_changed( GtkWidget *w, gpointer user_data );
static void gnc_sx_trans_window_response_cb(GtkDialog *dialog, gint response, gpointer data);
Index: gnc-plugin-page-register.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/Attic/gnc-plugin-page-register.h,v
retrieving revision 1.1.2.12
retrieving revision 1.1.2.13
diff -Lsrc/gnome/gnc-plugin-page-register.h -Lsrc/gnome/gnc-plugin-page-register.h -u -r1.1.2.12 -r1.1.2.13
--- src/gnome/gnc-plugin-page-register.h
+++ src/gnome/gnc-plugin-page-register.h
@@ -26,7 +26,7 @@
@{ */
/** @addtogroup RegisterPlugin Register Page
@{ */
-/** @file gnc-plugin-register-tree.h
+/** @file gnc-plugin-page-register.h
@brief utility functions for the GnuCash UI
@author Copyright (C) 2003 Jan Arne Petersen <jpetersen at uni-bonn.de>
@author Copyright (C) 2003 David Hampton <hampton at employees.org>
@@ -119,7 +119,7 @@
* @param lines_opt_name The name of the options (within the page
* specified above) containing the number of lines per register.
*
- * @param default_lines The number of lines to use if the specified
+ * @param lines_default The number of lines to use if the specified
* options cannot be found or has never been set.
*
* @param disallowCaps Capabilities to disable on this register.
@@ -158,7 +158,7 @@
/** Get the Account associated with this register page.
*
- * @param plugin_page A "register" page.
+ * @param page A "register" page.
*
* @return The account if the register contsins only a single
* account, or an account and its sub-accounts. NULL otherwise.
Index: window-main-summarybar.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/window-main-summarybar.c,v
retrieving revision 1.12.4.7
retrieving revision 1.12.4.8
diff -Lsrc/gnome/window-main-summarybar.c -Lsrc/gnome/window-main-summarybar.c -u -r1.12.4.7 -r1.12.4.8
--- src/gnome/window-main-summarybar.c
+++ src/gnome/window-main-summarybar.c
@@ -60,7 +60,7 @@
* kept around for the duration of the calculation. There may, in fact
* be better ways to do this, but none occurred.
*
- * @fixme This structure and the non-GUI code that computes it's values
+ * @todo This structure and the non-GUI code that computes it's values
* should move into the engine.
**/
typedef struct {
Index: gnc-split-reg.c
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/gnome/gnc-split-reg.c,v
retrieving revision 1.19.4.23
retrieving revision 1.19.4.24
diff -Lsrc/gnome/gnc-split-reg.c -Lsrc/gnome/gnc-split-reg.c -u -r1.19.4.23 -r1.19.4.24
--- src/gnome/gnc-split-reg.c
+++ src/gnome/gnc-split-reg.c
@@ -84,7 +84,7 @@
**/
-/** PROTOTYPES ******************************************************/
+/***** PROTOTYPES ***************************************************/
void gnc_split_reg_raise( GNCSplitReg *gsr );
static GtkWidget* add_summary_label( GtkWidget *summarybar,
Index: combocell.h
===================================================================
RCS file: /home/cvs/cvsroot/gnucash/src/register/register-core/combocell.h,v
retrieving revision 1.4.6.2
retrieving revision 1.4.6.3
diff -Lsrc/register/register-core/combocell.h -Lsrc/register/register-core/combocell.h -u -r1.4.6.2 -r1.4.6.3
--- src/register/register-core/combocell.h
+++ src/register/register-core/combocell.h
@@ -22,7 +22,7 @@
/**
* @file combocell.h
- * @breif The ComboCell object implements a cell handler with a
+ * @brief The ComboCell object implements a cell handler with a
* "combination-box" pull-down menu in it.
*
* On output, the currently selected menu item is displayed.
More information about the gnucash-changes
mailing list