[libgda] Documentation corrections, fixed bug #597390



commit d50ad324f8273fd032e833a5a8a143f33659ecad
Author: Vivien Malerba <malerba gnome-db org>
Date:   Wed Oct 7 18:21:38 2009 +0200

    Documentation corrections, fixed bug #597390

 libgda/gda-sql-builder.c |   11 ++++++++---
 libgda/gda-value.c       |    7 +++++++
 2 files changed, 15 insertions(+), 3 deletions(-)
---
diff --git a/libgda/gda-sql-builder.c b/libgda/gda-sql-builder.c
index dcf7c1f..941c53b 100644
--- a/libgda/gda-sql-builder.c
+++ b/libgda/gda-sql-builder.c
@@ -693,19 +693,24 @@ gda_sql_builder_add_expr (GdaSqlBuilder *builder, guint id, GdaDataHandler *dh,
  * @id: the requested ID, or 0 if to be determined by @builder
  * @string: a string
  *
- * Defines an expression in @builder which may be reused to build other parts of a statement.
+ * Defines an expression representing an identifier in @builder,
+ * which may be reused to build other parts of a statement.
  *
  * The new expression will contain the @string literal.
  * For example:
  * <programlisting>
- * gda_sql_builder_add_expr_liretal (b, 0, "name")
+ * gda_sql_builder_add_id (b, 0, "name")
+ * gda_sql_builder_add_id (b, 0, "date")
  * </programlisting>
  *
  * will be rendered as SQL as:
  * <programlisting>
  * name
+ * "date"
  * </programlisting>
  *
+ * because "date" is an SQL reserved keyword.
+ *
  * Returns: the ID of the new expression, or 0 if there was an error
  *
  * Since: 4.2
@@ -1165,7 +1170,7 @@ gda_sql_builder_add_function (GdaSqlBuilder *builder, guint id, const gchar *fun
  * @args: an array of IDs representing the function's arguments
  * @args_size: @args's size
  *
- * Builds a new expression which reprenents a function applied to some arguments
+ * Builds a new expression which represents a function applied to some arguments
  *
  * Returns: the ID of the new expression, or 0 if there was an error
  *
diff --git a/libgda/gda-value.c b/libgda/gda-value.c
index b36d79f..a603060 100644
--- a/libgda/gda-value.c
+++ b/libgda/gda-value.c
@@ -2490,6 +2490,13 @@ gda_ushort_get_type (void) {
  * where "xyz" is the octal representation of the byte, and the '\' (backslash) character
  * is converted to "\\".
  *
+ * Note that the backslash and newline characters are considered as printable characters and
+ * will not be represented by the "\xyz" representation.
+ *
+ * Use this function to get a representation as much readable by humans as possible of a binary
+ * chunk. Note that this function is internally called when transforming a binary value to
+ * a string for example when using g_value_transform() or gda_value_stringify().
+ *
  * Returns: a new string from @bin
  */
 gchar *



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