[Moneymanagerex-commits] SF.net SVN: moneymanagerex:[5930] trunk/src

[<ste...@us...>]

Revision: 5930
          http://sourceforge.net/p/moneymanagerex/code/5930
Author:   stef145g
Date:     2014-01-16 00:03:41 +0000 (Thu, 16 Jan 2014)
Log Message:
-----------
Update Documentation

Modified Paths:
--------------
    trunk/src/model/Model_Account.h
    trunk/src/model/Model_Asset.h
    trunk/src/model/Model_Billsdeposits.h
    trunk/src/model/Model_Budget.h
    trunk/src/model/Model_Budgetsplittransaction.h
    trunk/src/model/Model_Budgetyear.h
    trunk/src/model/Model_Category.h
    trunk/src/model/Model_Checking.h
    trunk/src/model/Model_Currency.h
    trunk/src/model/Model_Infotable.h
    trunk/src/model/Model_Payee.h
    trunk/src/model/Model_Report.h
    trunk/src/model/Model_Setting.h
    trunk/src/model/Model_Splittransaction.h
    trunk/src/model/Model_Stock.h
    trunk/src/model/Model_Subcategory.h
    trunk/src/singleton.h

Modified: trunk/src/model/Model_Account.h
===================================================================
--- trunk/src/model/Model_Account.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Account.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -43,19 +43,24 @@
 
 public:
     /**
-    * Initialize the global Model_Account table.
-    * Reset the Model_Account table or create the table if it does not exist.
+    Initialize the global Model_Account table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Account table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Account& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Account table */
+    /**
+    * Return the static instance address for Model_Account table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Account& instance();
 
 public:
-    /** Get the Data record instance in memory. */
+    /** Return the Data record for the given account name */
     Data* get(const wxString& name);
     
-    /** Remove the Data record instance from memory and the database. */
+    /** Remove the Data record from memory and the database. */
     bool remove(int id);
 
 public:

Modified: trunk/src/model/Model_Asset.h
===================================================================
--- trunk/src/model/Model_Asset.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Asset.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -40,12 +40,17 @@
 
 public:
     /**
-    * Initialize the global Model_Asset table.
-    * Reset the Model_Asset table or create the table if it does not exist.
+    Initialize the global Model_Asset table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Asset table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Asset& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Asset table */
+    /**
+    * Return the static instance address for Model_Asset table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Asset& instance();
 
 public:

Modified: trunk/src/model/Model_Billsdeposits.h
===================================================================
--- trunk/src/model/Model_Billsdeposits.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Billsdeposits.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -80,12 +80,17 @@
 
 public:
     /**
-    * Initialize the global Model_Billsdeposits table.
-    * Reset the Model_Billsdeposits table or create the table if it does not exist.
+    Initialize the global Model_Billsdeposits table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Billsdeposits table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Billsdeposits& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Billsdeposits table */
+    /**
+    * Return the static instance address for Model_Billsdeposits table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Billsdeposits& instance();
 
 public:

Modified: trunk/src/model/Model_Budget.h
===================================================================
--- trunk/src/model/Model_Budget.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Budget.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -30,12 +30,17 @@
 
 public:
     /**
-    * Initialize the global Model_Budget table.
-    * Reset the Model_Budget table or create the table if it does not exist.
+    Initialize the global Model_Budget table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Budget table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Budget& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Budget table */
+    /**
+    * Return the static instance address for Model_Budget table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Budget& instance();
 
 public:

Modified: trunk/src/model/Model_Budgetsplittransaction.h
===================================================================
--- trunk/src/model/Model_Budgetsplittransaction.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Budgetsplittransaction.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -30,12 +30,17 @@
 
 public:
     /**
-    * Initialize the global Model_Budgetsplittransaction table.
-    * Reset the Model_Budgetsplittransaction table or create the table if it does not exist.
+    Initialize the global Model_Budgetsplittransaction table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Budgetsplittransaction table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Budgetsplittransaction& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Budgetsplittransaction table */
+    /**
+    * Return the static instance address for Model_Budgetsplittransaction table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Budgetsplittransaction& instance();
 
 public:

Modified: trunk/src/model/Model_Budgetyear.h
===================================================================
--- trunk/src/model/Model_Budgetyear.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Budgetyear.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -33,12 +33,17 @@
 
 public:
     /**
-    * Initialize the global Model_Budgetyear table.
-    * Reset the Model_Budgetyear table or create the table if it does not exist.
+    Initialize the global Model_Budgetyear table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Budgetyear table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Budgetyear& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Budgetyear table */
+    /**
+    * Return the static instance address for Model_Budgetyear table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Budgetyear& instance();
 
     bool remove(int id);

Modified: trunk/src/model/Model_Category.h
===================================================================
--- trunk/src/model/Model_Category.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Category.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -35,12 +35,17 @@
 
 public:
     /**
-    * Initialize the global Model_Category table.
-    * Reset the Model_Category table or create the table if it does not exist.
+    Initialize the global Model_Category table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Category table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Category& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Category table */
+    /**
+    * Return the static instance address for Model_Category table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Category& instance();
 
 private:

Modified: trunk/src/model/Model_Checking.h
===================================================================
--- trunk/src/model/Model_Checking.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Checking.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -74,12 +74,17 @@
 
 public:
     /**
-    * Initialize the global Model_Checking table.
-    * Reset the Model_Checking table or create the table if it does not exist.
+    Initialize the global Model_Checking table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Checking table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Checking& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Checking table */
+    /**
+    * Return the static instance address for Model_Checking table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Checking& instance();
 
 public:

Modified: trunk/src/model/Model_Currency.h
===================================================================
--- trunk/src/model/Model_Currency.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Currency.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -32,12 +32,17 @@
 
 public:
     /**
-    * Initialize the global Model_Currency table.
-    * Reset the Model_Currency table or create the table if it does not exist.
+    Initialize the global Model_Currency table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Currency table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Currency& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Currency table */
+    /**
+    * Return the static instance address for Model_Currency table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Currency& instance();
 
 private:

Modified: trunk/src/model/Model_Infotable.h
===================================================================
--- trunk/src/model/Model_Infotable.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Infotable.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -31,12 +31,17 @@
 
 public:
     /**
-    * Initialize the global Model_Infotable.
-    * Reset the Model_Infotable or create the table if it does not exist.
+    Initialize the global Model_Infotable table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Infotable table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Infotable& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Infotable */
+    /**
+    * Return the static instance address for Model_Infotable table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Infotable& instance();
 
 public:

Modified: trunk/src/model/Model_Payee.h
===================================================================
--- trunk/src/model/Model_Payee.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Payee.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -34,12 +34,17 @@
 
 public:
     /**
-    * Initialize the global Model_Payee table.
-    * Reset the Model_Payee table or create the table if it does not exist.
+    Initialize the global Model_Payee table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Payee table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Payee& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Payee table */
+    /**
+    * Return the static instance address for Model_Payee table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Payee& instance();
 
 public:

Modified: trunk/src/model/Model_Report.h
===================================================================
--- trunk/src/model/Model_Report.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Report.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -33,14 +33,20 @@
     ~Model_Report();
 
 public:
-    /** Return the static instance of Model_Report table */
-    static Model_Report& instance();
+    /**
+    Initialize the global Model_Report table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Report table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
+    static Model_Report& instance(wxSQLite3Database* db);
 
     /**
-    * Initialize the global Model_Report table.
-    * Reset the Model_Report table or create the table if it does not exist.
+    * Return the static instance address for Model_Report table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
-    static Model_Report& instance(wxSQLite3Database* db);
+    static Model_Report& instance();
+
 public:
     wxString get_html(const Data* r);
     wxString get_html(const Data& r);

Modified: trunk/src/model/Model_Setting.h
===================================================================
--- trunk/src/model/Model_Setting.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Setting.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -31,12 +31,17 @@
 
 public:
     /**
-    * Initialize the global Model_Setting table.
-    * Reset the Model_Setting table or create the table if it does not exist.
+    Initialize the global Model_Setting table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Setting table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Setting& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Setting table. */
+    /**
+    * Return the static instance address for Model_Setting table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Setting& instance();
 
 public:

Modified: trunk/src/model/Model_Splittransaction.h
===================================================================
--- trunk/src/model/Model_Splittransaction.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Splittransaction.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -30,12 +30,17 @@
 
 public:
     /**
-    * Initialize the global Model_Splittransaction table.
-    * Reset the Model_Splittransaction table or create the table if it does not exist.
+    Initialize the global Model_Splittransaction table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Splittransaction table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Splittransaction& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Splittransaction table */
+    /**
+    * Return the static instance address for Model_Splittransaction table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Splittransaction& instance();
 
 public:

Modified: trunk/src/model/Model_Stock.h
===================================================================
--- trunk/src/model/Model_Stock.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Stock.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -30,12 +30,17 @@
 
 public:
     /**
-    * Initialize the global Model_Stock table.
-    * Reset the Model_Stock table or create the table if it does not exist.
+    Initialize the global Model_Stock table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Stock table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Stock& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Stock table */
+    /**
+    * Return the static instance address for Model_Stock table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Stock& instance();
 
 public:

Modified: trunk/src/model/Model_Subcategory.h
===================================================================
--- trunk/src/model/Model_Subcategory.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/model/Model_Subcategory.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -33,16 +33,21 @@
 
 public:
     /**
-    * Initialize the global Model_Subcategory table.
-    * Reset the Model_Subcategory table or create the table if it does not exist.
+    Initialize the global Model_Subcategory table on initial call.
+    Resets the global table on subsequent calls.
+    * Return the static instance address for Model_Subcategory table
+    * Note: Assigning the address to a local variable can destroy the instance.
     */
     static Model_Subcategory& instance(wxSQLite3Database* db);
 
-    /** Return the static instance of Model_Subcategory table */
+    /**
+    * Return the static instance address for Model_Subcategory table
+    * Note: Assigning the address to a local variable can destroy the instance.
+    */
     static Model_Subcategory& instance();
 
 public:
-    /** Return the Data record instance for the given subcategory name and category ID */
+    /** Return the Data record for the given subcategory name and category ID */
     Data* get(const wxString& name, int category_id);
 
 public:

Modified: trunk/src/singleton.h
===================================================================
--- trunk/src/singleton.h	2014-01-15 23:44:48 UTC (rev 5929)
+++ trunk/src/singleton.h	2014-01-16 00:03:41 UTC (rev 5930)
@@ -24,7 +24,7 @@
 {
 public:
     /**
-    * Returns the static instance for the given class.
+    * Returns the address of the static instance created for the class.
     * Creates the instance on first call.
     */
     static inline T& instance()

This was sent by MMEX an easy to use, money management application.