gnomemm r1779 - in libgdamm/trunk: . libgda/src

[jhs svn gnome org]

Author: jhs
Date: Mon Nov 10 08:28:58 2008
New Revision: 1779
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1779&view=rev

Log:
2008-11-10  Johannes Schmid  <jschmid openismus com>

	* libgda/src/datacomparator.hg:
	* libgda/src/quarklist.hg:
	* libgda/src/sqlparser.hg:
	* libgda/src/statement.hg:
	More documentation fixes

Modified:
   libgdamm/trunk/ChangeLog
   libgdamm/trunk/libgda/src/datacomparator.hg
   libgdamm/trunk/libgda/src/quarklist.hg
   libgdamm/trunk/libgda/src/sqlparser.hg
   libgdamm/trunk/libgda/src/statement.hg

Modified: libgdamm/trunk/libgda/src/datacomparator.hg
==============================================================================
--- libgdamm/trunk/libgda/src/datacomparator.hg	(original)
+++ libgdamm/trunk/libgda/src/datacomparator.hg	Mon Nov 10 08:28:58 2008
@@ -33,7 +33,23 @@
 
 typedef GdaDiff Diff;
 	
-/** FIXME
+/** Simple data model's contents comparison
+ *
+ * The GdaDataComparator is a simple object which takes two GdaDataModel objects
+ * and compare them. Actual comparison is performed when the 
+ * compute_diff() is called; for each difference found, the diff-computed signal
+ * is emitted (any user installed signal handler which returns FALSE stops 
+ * the computing process).
+ *
+ * After the differences have been computed, they can each be accessed using 
+ * gda_data_comparator_get_diff(), the number of differences found being 
+ * returned by gda_data_comparator_get_n_diffs().
+ * There are some limitations to this object:
+ * <ul>
+ *   <li>The data models compared must have the same number and type of columns</li>
+ *   <li>The comparison is done column-for-column: one cannot omit columns in the comparison,
+ * nor compare columns with different positions</li>
+ * </ul>
  *
  * @ingroup DataHandlers
  */

Modified: libgdamm/trunk/libgda/src/quarklist.hg
==============================================================================
--- libgdamm/trunk/libgda/src/quarklist.hg	(original)
+++ libgdamm/trunk/libgda/src/quarklist.hg	Mon Nov 10 08:28:58 2008
@@ -30,6 +30,12 @@
 namespace Gda
 {
 
+/** Quark lists (lists of KEY=VALUE's)
+  *
+  * Parameter lists are used primary in the parsing and creation of connection strings.
+  *
+  * @ingroup DataHandlers
+  */
 class QuarkList
 {
   _CLASS_BOXEDTYPE(QuarkList, GdaQuarkList, gda_quark_list_new, gda_quark_list_copy, gda_quark_list_free)

Modified: libgdamm/trunk/libgda/src/sqlparser.hg
==============================================================================
--- libgdamm/trunk/libgda/src/sqlparser.hg	(original)
+++ libgdamm/trunk/libgda/src/sqlparser.hg	Mon Nov 10 08:28:58 2008
@@ -51,11 +51,11 @@
  * for the next statement in the string to parse (and create a STATEMENT_UNKNOWN statement).
  * 
  * The Gda::SqlParser object parses and analyses SQL statements and reports the 
- *following statement types:
+ * following statement types:
  *
- * * SELECT (and COMPOUND select), INSERT, UPDATE and DELETE SQL statements should be completely parsed.
+ * - SELECT (and COMPOUND select), INSERT, UPDATE and DELETE SQL statements should be completely parsed.
  *
- * * Transaction related statements (corresponding to the BEGIN, COMMIT, 
+ * - Transaction related statements (corresponding to the BEGIN, COMMIT, 
  *   ROLLBACK, SAVEPOINT, ROLLBACK SAVEPOINT and DELETE SAVEPOINT) are parsed and a 
  *   minimalist structure is created to extract some information (that structure is not enough per-se to re-create the complete SQL statement).
  *
@@ -73,8 +73,8 @@
  * providers if the Gda::SqlParser is created using Gda::ServerProvider::create_parser() 
  * but for portability reasons it's better to avoid them):
  *
- * * ##NAME[::TYPE[::NULL]]: for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), and with the optional "::NULL" to instruct that the variable can be NULL.
- * * ## \/* name:NAME [type:TYPE] [nullok:[TRUE|FALSE]] [descr:DESCR] *\/ for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), with the optional "nullok" attribute and an optional description DESCR. Note that the NAME, TYPE and DESCR literals here must be quoted (simple or double quotes) if they include non alphanumeric characters, and that there must always be at least a space between the ## and the \/* ... *\/.
+ * - ##NAME[::TYPE[::NULL]]: for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), and with the optional "::NULL" to instruct that the variable can be NULL.
+ * - ## \/* name:NAME [type:TYPE] [nullok:[TRUE|FALSE]] [descr:DESCR] *\/ for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), with the optional "nullok" attribute and an optional description DESCR. Note that the NAME, TYPE and DESCR literals here must be quoted (simple or double quotes) if they include non alphanumeric characters, and that there must always be at least a space between the ## and the \/* ... *\/.
  *
  * @ingroup Connection
  */

Modified: libgdamm/trunk/libgda/src/statement.hg
==============================================================================
--- libgdamm/trunk/libgda/src/statement.hg	(original)
+++ libgdamm/trunk/libgda/src/statement.hg	Mon Nov 10 08:28:58 2008
@@ -47,10 +47,10 @@
  * structure, or from an SQL statement using a Gda::SqlParser object.
  * A GdaConnection can use a GdaStatement to:
  *
- *  * prepare it for a future execution, the preparation step involves converting the 
+ *  - prepare it for a future execution, the preparation step involves converting the 
  *     GdaStatement object into a structure used by the database's own API, see 
  *     Gda::Connection::statement_prepare()
- *  * execute it using Gda::Connection::statement_execute_select() if it is known
+ *  - execute it using Gda::Connection::statement_execute_select() if it is known
  *     that the statement is a selection statement, Gda::Connection::statement_execute_non_select() 
  *     if it is not a selection statement, or Gda::Connection::statement_execute()
  *     when the type of expected result is unknown.