Here's most of the other low-hanging fruit from doxygen.log -- about 70
typo corrections, making the documentation a little bit cleaner... As
before, further explanation of individual changes is available on
request.
Jesse Weinstein
=== modified file 'src/app-utils/file-utils.h'
--- src/app-utils/file-utils.h 2010-02-26 15:05:23 +0000
+++ src/app-utils/file-utils.h 2010-03-13 09:47:54 +0000
@@ -107,7 +107,7 @@
*
* @param guid The guid of the book associated with this data file.
*
- * @param next_filename Return the next available file name if the
+ * @param filename Return the next available file name if the
* data file cannot be found.
*
* @return The name of the data file that was located.
=== modified file 'src/backend/sql/gnc-slots-sql.h'
--- src/backend/sql/gnc-slots-sql.h 2010-02-18 05:31:54 +0000
+++ src/backend/sql/gnc-slots-sql.h 2010-03-13 09:43:59 +0000
@@ -53,11 +53,9 @@
*/
gboolean gnc_sql_slots_delete( GncSqlBackend* be, const GUID* guid );
-/**
- * gnc_sql_slots_load - Loads slots for an object from the db.
+/** Loads slots for an object from the db.
*
* @param be SQL backend
- * @param guid Object guid
*/
void gnc_sql_slots_load( GncSqlBackend* be, QofInstance* inst );
@@ -71,6 +69,7 @@
*/
void gnc_sql_slots_load_for_list( GncSqlBackend* be, GList* list );
+
/**
* gnc_sql_slots_load_for_sql_subquery - Loads slots for all objects whose guid is
* supplied by a subquery. The subquery should be of the form "SELECT DISTINCT guid FROM ...".
@@ -80,11 +79,11 @@
* @param subquery Subquery SQL string
* @param lookup_fn Lookup function to get the right object from the book
*/
-typedef QofInstance* (*BookLookupFn)( const GUID* guid, const QofBook* book );
-
void gnc_sql_slots_load_for_sql_subquery( GncSqlBackend* be, const gchar* subquery,
BookLookupFn lookup_fn );
void gnc_sql_init_slots_handler( void );
+typedef QofInstance* (*BookLookupFn)( const GUID* guid, const QofBook* book );
+
#endif /* GNC_SLOTS_SQL_H_ */
=== modified file 'src/core-utils/gnc-filepath-utils.c'
--- src/core-utils/gnc-filepath-utils.c 2010-03-05 20:15:31 +0000
+++ src/core-utils/gnc-filepath-utils.c 2010-03-13 09:39:51 +0000
@@ -89,9 +89,7 @@
return NULL;
}
-/** @fn char * gnc_resolve_file_path (const char * filefrag)
- *
- * @brief Create an absolute path when given a relative path;
+/** @brief Create an absolute path when given a relative path;
* otherwise return the argument.
*
* @warning filefrag should be a simple path fragment. It shouldn't
@@ -180,8 +178,8 @@
/* ====================================================================== */
-/** @fn void gnc_validate_directory (const gchar *dirname)
- * @brief Check that the supplied directory path exists, is a directory, and that the user has adequate permissions to use it.
+/** @brief Check that the supplied directory path exists, is a directory, and
+ * that the user has adequate permissions to use it.
*
* @param dirname The path to check
*/
=== modified file 'src/core-utils/gnc-uri-utils.h'
--- src/core-utils/gnc-uri-utils.h 2010-03-05 20:15:31 +0000
+++ src/core-utils/gnc-uri-utils.h 2010-03-13 09:55:31 +0000
@@ -44,7 +44,7 @@
* Uri's can take any of the following forms:
*
* @li @c /some/filesystem/path A simple file system path (unix style)
- * @li @c c:\\some\windows\path A simple file system path (Windows style)
+ * @li @c c:\\some\\windows\\path A simple file system path (Windows style)
* @li @c proto://[[username[:passwo...@]hostname[:port]]/path (universal uri)
*
* In the last form, anything in square brackets is optional.
@@ -62,9 +62,9 @@
* the 'file' protocol, this will be NULL
* @param port An optional port to connect to or 0 if the default port is to
* be used. For the 'file' protocol this is always 0 as well.
- * @username Optional user name found in this uri or NULL if none is found.
- * @password Optional password found in this uri or NULL if none is found.
- * @path The path found in this uri. Note that if the protocol is a file based
+ * @param username Optional user name found in this uri or NULL if none is found.
+ * @param password Optional password found in this uri or NULL if none is found.
+ * @param path The path found in this uri. Note that if the protocol is a file based
* protocol, the path will be converted to an absolute path.
*
*/
@@ -82,7 +82,7 @@
* Uri's can take any of the following forms:
*
* @li @c /some/filesystem/path A simple file system path (unix style)
- * @li @c c:\\some\windows\path A simple file system path (Windows style)
+ * @li @c c:\\some\\windows\\path A simple file system path (Windows style)
* @li @c proto://[[username[:passwo...@]hostname[:port]]/path (universal uri)
*
* In the last form, anything in square brackets is optional.
@@ -103,7 +103,7 @@
* Uri's can take any of the following forms:
*
* @li @c /some/filesystem/path A simple file system path (unix style)
- * @li @c c:\\some\windows\path A simple file system path (Windows style)
+ * @li @c c:\\some\\windows\\path A simple file system path (Windows style)
* @li @c proto://[[username[:passwo...@]hostname[:port]]/path (universal uri)
*
* In the last form, anything in square brackets is optional.
@@ -138,11 +138,11 @@
* @param port An optional port to set o, the uri, or 0 if no port is to be
* set. This will be ignored for the 'file' type protocols ('file', 'xml',
* 'sqlite').
- * @username Optional user name to set in the uri or NULL otherwise. This will
- * be ignored for the 'file' type protocols ('file', 'xml', 'sqlite').
- * @password Optional password to set in the uri or NULL otherwise. This will
- * be ignored for the 'file' type protocols ('file', 'xml', 'sqlite').
- * @path The path to set in the uri.
+ * @param username Optional user name to set in the uri or NULL otherwise. This will
+ * be ignored for the 'file' type protocols ('file', 'xml', 'sqlite').
+ * @param password Optional password to set in the uri or NULL otherwise. This will
+ * be ignored for the 'file' type protocols ('file', 'xml', 'sqlite').
+ * @param path The path to set in the uri.
*
* @return The normalized uri.
*/
=== modified file 'src/engine/gnc-commodity.h'
--- src/engine/gnc-commodity.h 2010-03-01 18:44:07 +0000
+++ src/engine/gnc-commodity.h 2010-03-13 09:59:27 +0000
@@ -277,7 +277,7 @@
* @param fullname The complete name of this commodity. E.G. "Acme
* Systems, Inc."
*
- * @param namespace An aggregation of commodities. E.G. ISO4217,
+ * @param commodity_namespace An aggregation of commodities. E.G. ISO4217,
* Nasdaq, Downbelow, etc.
*
* @param mnemonic An abbreviation for this stock. For publicly
@@ -497,7 +497,7 @@
*
* @param cm A pointer to a commodity data structure.
*
- * @param namespace A pointer to the namespace for this commodity.
+ * @param new_namespace A pointer to the namespace for this commodity.
* This string belongs to the caller and will be duplicated by the
* engine.
*/
@@ -663,7 +663,7 @@
/** Checks to see if the specified commodity namespace is the
* namespace for ISO 4217 currencies.
*
- * @param namespace The string to check.
+ * @param commodity_namespace The string to check.
*
* @return TRUE if the string indicates an ISO currency, FALSE otherwise. */
gboolean gnc_commodity_namespace_is_iso(const char *commodity_namespace);
@@ -805,7 +805,7 @@
*
* @param table A pointer to the commodity table
*
- * @param namespace The new namespace to check.
+ * @param commodity_namespace The new namespace to check.
*
* @return 1 if the namespace exists. 0 if it doesn't exist, or the
* routine was passed a bad argument. */
@@ -835,7 +835,7 @@
*
* @param table A pointer to the commodity table
*
- * @param namespace The new namespace to be added.
+ * @param commodity_namespace The new namespace to be added.
*
* @param book The book that the new namespace will belong to.
*
@@ -848,7 +848,7 @@
*
* @param table A pointer to the commodity table
*
- * @param namespace The new namespace to be added.
+ * @param commodity_namespace The new namespace to be added.
*
* @return The a pointer to the namespace found, or NULL if the
* namespace doesn't exist. */
@@ -860,7 +860,7 @@
*
* @param table A pointer to the commodity table
*
- * @param namespace The namespace to be deleted.
+ * @param commodity_namespace The namespace to be deleted.
*
* @note This routine will destroy any commodities that exist as part
* of this namespace. Use it carefully. */
@@ -885,7 +885,7 @@
*
* @param table A pointer to the commodity table
*
- * @param namespace A string indicating which commodities should be
+ * @param commodity_namespace A string indicating which commodities should be
* returned. It is a required argument.
*
* @return A pointer to the list of commodities. NULL if an invalid
=== modified file 'src/gnome-utils/gnc-main-window.c'
--- src/gnome-utils/gnc-main-window.c 2010-03-10 16:05:55 +0000
+++ src/gnome-utils/gnc-main-window.c 2010-03-13 10:04:00 +0000
@@ -2201,7 +2201,7 @@
* initializes the object private storage space. It also adds the
* new object to a list (for memory tracking purposes).
*
- * @param view The new object instance created by the object system.
+ * @param window The new object instance created by the object system.
*
* @param klass A pointer to the class data structure for this
* object. */
@@ -3990,7 +3990,7 @@
* This function is called via a vector off a generic window
* interface.
*
- * @param window_in A pointer to a generic window. */
+ * @param window A pointer to a generic window. */
static GtkWindow *
gnc_main_window_get_gtk_window (GncWindow *window)
{
=== modified file 'src/gnome-utils/gnc-main-window.h'
--- src/gnome-utils/gnc-main-window.h 2010-03-02 21:42:11 +0000
+++ src/gnome-utils/gnc-main-window.h 2010-03-13 10:04:36 +0000
@@ -161,9 +161,8 @@
/** Update the name of the page in the main window.
*
- * @parm page The page to be updated.
- *
- * @parm name_in The new name for the page.
+ * @param page The page to be updated.
+ * @param name_in The new name for the page.
*/
void
main_window_update_page_name (GncPluginPage *page,
@@ -172,9 +171,8 @@
/** Update the color on the page tabs in the main window.
*
- * @parm page The page to be updated.
- *
- * @parm color_in The new color string for the page tab.
+ * @param page The page to be updated.
+ * @param color_in The new color string for the page tab.
*/
void
main_window_update_page_color (GncPluginPage *page,
=== modified file 'src/gnome-utils/gnc-tree-view.c'
--- src/gnome-utils/gnc-tree-view.c 2010-03-02 21:42:11 +0000
+++ src/gnome-utils/gnc-tree-view.c 2010-03-13 10:07:27 +0000
@@ -592,7 +592,7 @@
* underlying GtkTreeModel. It propagates these changes to gconf to
* keep it in sync with the user's view of the tree.
*
- * @param sortable The underlying sortable model.
+ * @param treesortable The underlying sortable model.
*
* @param view A pointer to the GncTreeView that displays the model
* data.
@@ -781,7 +781,7 @@
* that gconf visibility keys have been seen. (This handles the
* 'first run' case where gconf should manage a view but no keys yet
* exist in gconf.) If so, the gconf visibility key is returned.
- * Otherwise the "'default visible column' list is checked and a
+ * Otherwise the 'default visible column' list is checked and a
* value of TRUE returned if the pref name is found, otherwise FALSE.
*
* @param view A GncTreeView.
@@ -898,7 +898,7 @@
* is careful to prevent an infinite loop by blocking the
* "sort-column-changed" callback that is attached to the model.
*
- * @param widget The tree view.
+ * @param view The tree view.
*
* @param name The sort order enum (in string form). Either
* "ascending" or "descending".
@@ -937,7 +937,7 @@
* infinite loop by blocking the "sort-column-changed" callback that
* is attached to the model.
*
- * @param widget The tree view.
+ * @param view The tree view.
*
* @param name The name of the column that should be made the sort column.
*
@@ -990,9 +990,9 @@
* This function is careful to prevent an infinite loop by blocking
* the "columns-changed" callback that is attached to the view.
*
- * @param widget The tree view.
+ * @param view The tree view.
*
- * @param name A list of pointers to strings. These strings are the
+ * @param column_names A list of pointers to strings. These strings are the
* names of the columns in the order they should appear.
*
* @internal
@@ -1044,11 +1044,11 @@
* @param client A pointer to the gconf client object from which
* detected a change in gconf. Unused by this function.
*
- * @cnxn_id The identifier for the notification that this callback
+ * @param cnxn_id The identifier for the notification that this callback
* represents. Unused since this code only has a single notification
* request.
*
- * @entry A pointer to the key/value pair in gconf that changed.
+ * @param entry A pointer to the key/value pair in gconf that changed.
*
* @param data The tree view.
*
@@ -1786,7 +1786,7 @@
* @param resizable Whether to mark the column as user resizable.
* This marking is only relevant for fixed width columns.
*
- * @param column_sort_function The function that GtkTreeModelSort
+ * @param column_sort_fn The function that GtkTreeModelSort
* will call to compare two rows to determine their displayed order.
*
* @internal
=== modified file 'src/gnome/gnc-plugin-page-account-tree.c'
--- src/gnome/gnc-plugin-page-account-tree.c 2010-02-27 16:32:01 +0000
+++ src/gnome/gnc-plugin-page-account-tree.c 2010-03-13 10:00:57 +0000
@@ -576,7 +576,7 @@
/** Save enough information about this account tree page that it can
* be recreated next time the user starts gnucash.
*
- * @param page The page to save.
+ * @param plugin_page The page to save.
*
* @param key_file A pointer to the GKeyFile data structure where the
* page information should be written.
=== modified file 'src/gnome/gnc-plugin-page-register.c'
--- src/gnome/gnc-plugin-page-register.c 2010-03-03 20:59:58 +0000
+++ src/gnome/gnc-plugin-page-register.c 2010-03-13 10:01:33 +0000
@@ -980,7 +980,7 @@
/** Save enough information about this register page that it can be
* recreated next time the user starts gnucash.
*
- * @param page The page to save.
+ * @param plugin_page The page to save.
*
* @param key_file A pointer to the GKeyFile data structure where the
* page information should be written.
@@ -3178,7 +3178,7 @@
* responsible for finding all open registers containing the account
* and closing them.
*
- * @param accoung A pointer to the account that was changed.
+ * @param account A pointer to the account that was changed.
*/
static void
gppr_account_destroy_cb (Account *account)
=== modified file 'src/gnome/gnc-plugin-page-sx-list.c'
--- src/gnome/gnc-plugin-page-sx-list.c 2010-03-03 20:47:10 +0000
+++ src/gnome/gnc-plugin-page-sx-list.c 2010-03-13 10:01:53 +0000
@@ -401,10 +401,9 @@
}
}
-/**
- * Save enough information about this page that it can be recreated next time
+/** Save enough information about this page that it can be recreated next time
* the user starts gnucash.
- * @param page The page to save.
+ * @param plugin_page The page to save.
* @param key_file A pointer to the GKeyFile data structure where the
* page information should be written.
* @param group_name The group name to use when saving data.
=== modified file 'src/libqof/qof/qofid.h'
--- src/libqof/qof/qofid.h 2009-09-18 18:40:57 +0000
+++ src/libqof/qof/qofid.h 2010-03-13 10:09:45 +0000
@@ -135,13 +135,14 @@
*/
-/** Is QOF operating in "alternate" dirty mode. In normal mode,
- * whenever an instance is dirtied, the collection (and therefore the
- * book) is immediately marked as dirty. In alternate mode, the
- * collection is only marked dirty when a dirty instance is
- * committed. If a dirty instance is freed instead of committed, the
- * dirty state of collection (and therefore the book) is never
- * changed. */
+/** Is QOF operating in "alternate" dirty mode?
+ *
+ * In normal mode, whenever an instance is dirtied, the collection
+ * (and therefore the book) is immediately marked as dirty. In
+ * alternate mode, the collection is only marked dirty when a dirty
+ * instance is committed. If a dirty instance is freed instead of
+ * committed, the dirty state of collection (and therefore the book)
+ * is never changed. */
gboolean qof_get_alt_dirty_mode (void);
/** Set QOF into "alternate" dirty mode. In normal mode, whenever an
=== modified file 'src/register/register-core/cellblock.h'
--- src/register/register-core/cellblock.h 2010-03-02 21:41:39 +0000
+++ src/register/register-core/cellblock.h 2010-03-13 10:12:15 +0000
@@ -71,8 +71,8 @@
BasicCell * gnc_cellblock_get_cell (CellBlock *cellblock,
int row, int col);
-/** Searches by name for a particular cell in a CellBlock. Parameters @row
- * and/or @col may be @c NULL.
+/** Searches by name for a particular cell in a CellBlock. Parameters @c row
+ * and/or @c col may be @c NULL.
*
* @param cellblock a ::CellBlock to search
*
=== modified file 'src/report/report-gnome/gnc-plugin-page-report.c'
--- src/report/report-gnome/gnc-plugin-page-report.c 2010-02-18 05:31:54 +0000
+++ src/report/report-gnome/gnc-plugin-page-report.c 2010-03-13 10:12:35 +0000
@@ -704,7 +704,7 @@
/** Save enough information about this report page that it can be
* recreated next time the user starts gnucash.
*
- * @param page The page to save.
+ * @param plugin_page The page to save.
*
* @param key_file A pointer to the GKeyFile data structure where the
* page information should be written.
_______________________________________________
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
