[seed] [docs] Expand seed_value_to_string docs to explain various conditions
- From: Tim Horton <hortont src gnome org>
- To: svn-commits-list gnome org
- Subject: [seed] [docs] Expand seed_value_to_string docs to explain various conditions
- Date: Sun, 12 Jul 2009 05:57:27 +0000 (UTC)
commit 2ca762eb8626ee08057a9a35e9531b917ed06102
Author: Tim Horton <hortont424 gmail com>
Date: Sat Jul 11 21:12:47 2009 -0400
[docs] Expand seed_value_to_string docs to explain various conditions
libseed/seed-types.c | 10 ++++++++++
1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/libseed/seed-types.c b/libseed/seed-types.c
index 3eeac4d..738ce6c 100644
--- a/libseed/seed-types.c
+++ b/libseed/seed-types.c
@@ -1908,6 +1908,16 @@ seed_value_from_double (JSContextRef ctx, gdouble val, JSValueRef * exception)
* Converts the given #SeedValue into a #gchar* string. Keep in mind that it's
* up to the caller to free the string.
*
+ * If the #SeedValue represents JavaScript's undefined value, this returns
+ * "[undefined]"; if it represents JavaScript's null value, this returns
+ * "[null]".
+ *
+ * If the #SeedValue is a number or a boolean, it is printed as a double, with
+ * the printf format string "%.15g".
+ *
+ * If the #SeedValue is an object, the string returned is that obtained by
+ * calling .toString() on said object.
+ *
* Return value: The #gchar* represented by @val, or %NULL if an exception
* is raised during the conversion.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]