The log of warnings from doxygen, doxygen.log, is actually quite useful.
Here's a patch fixing various typos I found by looking through those
warnings. There are lots more to do... Hopefully they should all be
obvious once seen, but if not, I'll be glad to explain any of them in
more detail.
Jesse Weinstein
=== modified file 'src/backend/sql/gnc-backend-sql.h'
--- src/backend/sql/gnc-backend-sql.h 2010-02-18 05:31:54 +0000
+++ src/backend/sql/gnc-backend-sql.h 2010-03-03 09:55:41 +0000
@@ -28,8 +28,7 @@
@ingroup SQLBE
*/
-/** @addtogroup SQLBE
- * The SQL backend core is a library which can form the core for a QOF
+/** The SQL backend core is a library which can form the core for a QOF
* backend based on an SQL library.
*
* @file gnc-backend-sql.h
@@ -101,7 +100,7 @@
/**
* Object editing has been cancelled.
*
- * @param be SQL backend
+ * @param qbe SQL backend
* @param inst Object being edited
*/
void gnc_sql_rollback_edit( GncSqlBackend* qbe, QofInstance *inst );
@@ -109,7 +108,7 @@
/**
* Object editting is complete and the object should be saved.
*
- * @param be SQL backend
+ * @param qbe SQL backend
* @param inst Object being edited
*/
void gnc_sql_commit_edit( GncSqlBackend* qbe, QofInstance *inst );
@@ -418,7 +417,7 @@
* all of the column names for the pieces are added.
*
* @param table_row DB table column
- * @pList List
+ * @param pList List
*/
void gnc_sql_add_colname_to_list( const GncSqlColumnTableEntry* table_row, GList** pList );
@@ -520,17 +519,9 @@
*/
gint gnc_sql_get_table_version( const GncSqlBackend* be, const gchar* table_name );
-/**
- * Sets the version number for a DB table.
- *
- * @param be SQL backend struct
- * @param table_name Table name
- * @param table_version Table version
- * @return TRUE if successful, FALSE if unsuccessful
- */
gboolean gnc_sql_set_table_version( GncSqlBackend* be,
const gchar* table_name,
- gint table_version );
+ gint version );
/**
* Creates a table in the database
=== modified file 'src/engine/gnc-filepath-utils.c'
--- src/engine/gnc-filepath-utils.c 2010-03-02 21:40:28 +0000
+++ src/engine/gnc-filepath-utils.c 2010-03-03 09:46:06 +0000
@@ -79,14 +79,12 @@
}
}
-/** \fn gchar * check_file_return_if_true (path)
- * \brief Check if the path exists and is a regular file
+/** Check if the path exists and is a regular file.
*
* \param path -- freed if the path doesn't exist or isn't a regular file
*
* \return NULL or the path
*/
-
static gchar *
check_path_return_if_valid(gchar *path)
{
@@ -229,7 +227,7 @@
* @brief Return the passed-in string unless it starts with file:,
* xml:, or is a raw relative path.
*
- * Strings starting with "http://, https://, or a "registered scheme"
+ * Strings starting with http://, https://, or a "registered scheme"
* (see qof_backend_get_registered_access_method_list()) are returned
* as-is by this function.
*
=== modified file 'src/import-export/csv/gnc-csv-model.c'
--- src/import-export/csv/gnc-csv-model.c 2010-03-02 21:40:02 +0000
+++ src/import-export/csv/gnc-csv-model.c 2010-03-03 09:48:02 +0000
@@ -480,7 +480,7 @@
* right now.)
* @param parse_data Data that is being parsed
* @param guessColTypes TRUE to guess what the types of columns are based on the cell contents
- * @error error Will contain an error if there is a failure
+ * @param error Will contain an error if there is a failure
* @return 0 on success, 1 on failure
*/
int gnc_csv_parse(GncCsvParseData* parse_data, gboolean guessColTypes, GError** error)
_______________________________________________
gnucash-devel mailing list
[email protected]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
