[libgda] Documentation corrections
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] Documentation corrections
- Date: Wed, 2 Apr 2014 19:33:55 +0000 (UTC)
commit c817cbc28fa0b23ba697f61e0833bfc5c95a8aa3
Author: Vivien Malerba <malerba gnome-db org>
Date: Wed Apr 2 18:36:11 2014 +0200
Documentation corrections
libgda/gda-holder.c | 3 +++
libgda/gda-value.c | 2 +-
libgda/sql-parser/gda-statement-struct-util.c | 1 +
3 files changed, 5 insertions(+), 1 deletions(-)
---
diff --git a/libgda/gda-holder.c b/libgda/gda-holder.c
index a6a9136..0778322 100644
--- a/libgda/gda-holder.c
+++ b/libgda/gda-holder.c
@@ -966,6 +966,9 @@ gda_holder_set_value_str (GdaHolder *holder, GdaDataHandler *dh, const gchar *va
* stored internally will be forgiven and replaced by the @value. User should then
* take care of the 'old' static GValue.
*
+ * Note4: in any case, the caller should not use @value anymore after this function returns because it may
+ * have been freed. If necessary, use gda_holder_get_value() to get the real value.
+ *
* Returns: TRUE if value has been set
*/
gboolean
diff --git a/libgda/gda-value.c b/libgda/gda-value.c
index eb78696..cc69aa6 100644
--- a/libgda/gda-value.c
+++ b/libgda/gda-value.c
@@ -1494,7 +1494,7 @@ gda_timestamp_change_timezone (GdaTimestamp *ts, glong ntz)
* gda_value_new: (skip)
* @type: the new value type.
*
- * Makes a new #GValue of type @type.
+ * Creates a new #GValue of type @type, left in the same state as when g_value_init() is called.
*
* Returns: (transfer full): the newly created #GValue with the specified @type. You need to set the value
in the returned GValue.
*
diff --git a/libgda/sql-parser/gda-statement-struct-util.c b/libgda/sql-parser/gda-statement-struct-util.c
index bbcd6c3..168ad4a 100644
--- a/libgda/sql-parser/gda-statement-struct-util.c
+++ b/libgda/sql-parser/gda-statement-struct-util.c
@@ -327,6 +327,7 @@ _string_is_identifier (const gchar *str)
* This function is normally used only by database provider's implementation.
*
* WARNING: @str must NOT be a composed identifier (<part1>."<part2>" for example)
+ * WARNING: you may have to <code>#include <sql-parser/gda-sql-parser.h></code>
*
* Returns: @str
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]