r18162 - gnucash/trunk/src/backend/sql - Add some doxygen routine headers

[Phil Longstaff]

Author: plongstaff
Date: 2009-06-28 18:53:51 -0400 (Sun, 28 Jun 2009)
New Revision: 18162
Trac: http://svn.gnucash.org/trac/changeset/18162

Modified:
   gnucash/trunk/src/backend/sql/gnc-transaction-sql.c
Log:
Add some doxygen routine headers


Modified: gnucash/trunk/src/backend/sql/gnc-transaction-sql.c
===================================================================
--- gnucash/trunk/src/backend/sql/gnc-transaction-sql.c	2009-06-28 22:52:56 UTC (rev 18161)
+++ gnucash/trunk/src/backend/sql/gnc-transaction-sql.c	2009-06-28 22:53:51 UTC (rev 18162)
@@ -293,7 +293,10 @@
 } full_acct_balances_t;
 
 /**
- * Save the start/end balances for an account.
+ * Saves the start/end balances for an account.
+ *
+ * @param acc Account
+ * @param pData Pointer to balances info list
  */
 static void
 save_account_balances( Account* acc, gpointer pData )
@@ -338,6 +341,9 @@
 /**
  * Executes a transaction query statement and loads the transactions and all
  * of the splits.
+ *
+ * @param be SQL backend
+ * @param stmt SQL statement
  */
 static void
 query_transactions( GncSqlBackend* be, GncSqlStatement* stmt )
@@ -443,6 +449,11 @@
 }
 
 /* ================================================================= */
+/**
+ * Creates the transaction and split tables.
+ *
+ * @param be SQL backend
+ */
 static void
 create_transaction_tables( GncSqlBackend* be )
 {
@@ -487,6 +498,12 @@
     }
 }
 /* ================================================================= */
+/**
+ * Callback function to delete slots for a split
+ *
+ * @param data Split
+ * @param user_data split_info_t structure contain operation info
+ */
 static void
 delete_split_slots_cb( gpointer data, gpointer user_data )
 {
@@ -503,6 +520,13 @@
 	}
 }
 
+/**
+ * Deletes all of the splits for a transaction
+ *
+ * @param be SQL backend
+ * @param pTx Transaction
+ * @return TRUE if successful, FALSE if unsuccessful
+ */
 static gboolean
 delete_splits( GncSqlBackend* be, Transaction* pTx )
 {
@@ -523,6 +547,13 @@
 	return split_info.is_ok;
 }
 
+/**
+ * Commits a split to the database
+ *
+ * @param be SQL backend
+ * @param inst Split
+ * @return TRUE if successful, FALSE if error
+ */
 static gboolean
 commit_split( GncSqlBackend* be, QofInstance* inst )
 {