[libgda] Some documentation fixes.



commit ef10464b39493bad6fb81e22bc4ebca66702e847
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Sep 21 10:47:41 2011 +0200

    Some documentation fixes.

 libgda/gda-connection.c               |    2 +-
 libgda/gda-quark-list.h               |    2 +-
 libgda/sql-parser/gda-sql-statement.h |    7 +++----
 3 files changed, 5 insertions(+), 6 deletions(-)
---
diff --git a/libgda/gda-connection.c b/libgda/gda-connection.c
index 845f370..d9df542 100644
--- a/libgda/gda-connection.c
+++ b/libgda/gda-connection.c
@@ -2321,7 +2321,7 @@ gda_connection_delete_row_from_table (GdaConnection *cnc, const gchar *table,
  * @params: (out) (allow-none) (transfer full): a place to store a new #GdaSet, for parameters used in SQL command, or %NULL
  * @error: a place to store errors, or %NULL
  *
- * This function helps to parse a SQL string which uses paramenters and store them at @params.
+ * This function helps to parse a SQL string which uses parameters and store them at @params.
  *
  * Returns: (transfer full) (allow-none): a #GdaStatement representing the SQL command, or %NULL if an error occurred
  *
diff --git a/libgda/gda-quark-list.h b/libgda/gda-quark-list.h
index cf82551..9b34a7b 100644
--- a/libgda/gda-quark-list.h
+++ b/libgda/gda-quark-list.h
@@ -40,7 +40,7 @@ typedef struct _GdaQuarkList GdaQuarkList;
  * @stability: Stable
  * @see_also:
  *
- * This object is used mainly by database provider's implementation to parse connection
+ * This object is used mainly by database providers' implementations to parse connection
  * strings into lists of KEY=VALUE pairs.
  */
 
diff --git a/libgda/sql-parser/gda-sql-statement.h b/libgda/sql-parser/gda-sql-statement.h
index c3dfd02..116a472 100644
--- a/libgda/sql-parser/gda-sql-statement.h
+++ b/libgda/sql-parser/gda-sql-statement.h
@@ -28,13 +28,12 @@ G_BEGIN_DECLS
 
 /**
  * SECTION:gda-sql-statement
- * @short_description: SQL parser
- * @title: GdaSqlParser
+ * @short_description: SQL statement
+ * @title: GdaSqlStatement
  * @stability: Stable
  * @see_also: The #GdaSqlBuilder object which features some easy to use API to build #GdaSqlStatement structures or #GdaStatement objects without having to worry about the details of #GdaSqlStatement's contents.
  *
- * Please note that it is not advised to build #GdaSqlStatement structures directly, but rather
- * it is recommended to use the #GdaSqlBuilder object and its associated API.
+ * Use the #GdaSqlBuilder object to build #GdaSqlStatement structures.
  *
  * Every SQL statement can be decomposed in a #GdaSqlStatement structure. This is not a #GObject, but rather just a C structure
  * which can be manipulated directly. The structure is a tree composed of several key structures which are show in the following diagram



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