[glom] DbUtils: Update some comments



commit 400e33766bb01a5d77a4523b09f2ce9a9ea19e86
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Mar 1 11:47:47 2012 +0100

    DbUtils: Update some comments

 glom/libglom/db_utils.h |   12 +++++++++---
 1 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/glom/libglom/db_utils.h b/glom/libglom/db_utils.h
index 1633782..35e4968 100644
--- a/glom/libglom/db_utils.h
+++ b/glom/libglom/db_utils.h
@@ -70,8 +70,11 @@ type_vec_fields get_fields_for_table(const Document* document, const Glib::ustri
  */
 sharedptr<Field> get_fields_for_table_one_field(const Document* document, const Glib::ustring& table_name, const Glib::ustring& field_name);
 
-//TODO: Is this used directly?
 typedef std::vector<Glib::ustring> type_vec_strings;
+
+/** Get the table names from the database server.
+ * This could theoretically be different than the ones listed in the document.
+ */
 type_vec_strings get_table_names_from_database(bool ignore_system_tables = false);
 
 bool get_table_exists_in_database(const Glib::ustring& table_name);
@@ -90,7 +93,8 @@ bool add_column(const Glib::ustring& table_name, const sharedptr<const Field>& f
 bool drop_column(const Glib::ustring& table_name, const Glib::ustring& field_name);
 
 
-//TODO: Is this used directly?
+/** Insert example data, from the document, into the table on the database server.
+ */
 bool insert_example_data(Document* document, const Glib::ustring& table_name);
 
 /** Execute a SQL Select command, returning the result.
@@ -114,7 +118,9 @@ bool query_execute_string(const Glib::ustring& strQuery,
   */
 bool query_execute(const Glib::RefPtr<const Gnome::Gda::SqlBuilder>& builder);
 
-//TODO: Is this used directly?
+/** Insert the auto-increment row in the database preferences table, if necessary,
+ * returning the next value.
+ */
 Gnome::Gda::Value auto_increment_insert_first_if_necessary(const Glib::ustring& table_name, const Glib::ustring& field_name);
 
 /** Get the next auto-increment value for this primary key, from the glom system table.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]