aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPetri Lehtinen <petri@digip.org>2009-10-13 22:51:04 +0300
committerPetri Lehtinen <petri@digip.org>2009-10-14 08:23:02 +0300
commit951d091f071a3b1fe4c0ae29e31e94b9c475473e (patch)
tree6564fa0f50caa86e9a95f4db71b7d7003d423f07 /doc
parent185e107d24f24a4641d598722bc3f60eac10effc (diff)
downloadjansson-951d091f071a3b1fe4c0ae29e31e94b9c475473e.zip
jansson-951d091f071a3b1fe4c0ae29e31e94b9c475473e.tar.gz
jansson-951d091f071a3b1fe4c0ae29e31e94b9c475473e.tar.bz2
Make integer, real and string mutable
Added functions: json_string_set json_integer_set json_real_set While at it, clarify the documentation and parameter naming of json_{string,integer,real}_value() a bit.
Diffstat (limited to 'doc')
-rw-r--r--doc/apiref.rst41
1 files changed, 31 insertions, 10 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst
index 1a6a77b..cc36117 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -194,11 +194,18 @@ String
Returns a new JSON string, or *NULL* on error. *value* must be a
valid UTF-8 encoded Unicode string.
-.. cfunction:: const char *json_string_value(const json_t *json)
+.. cfunction:: const char *json_string_value(const json_t *string)
- Returns the associated value of the JSON string *json* as a null
- terminated UTF-8 encoded string, or *NULL* if *json* is not a JSON
- string.
+ Returns the associated value of *string* as a null terminated UTF-8
+ encoded string, or *NULL* if *string* is not a JSON string.
+
+.. cfunction:: int json_string_set(const json_t *string, const char *value)
+
+ Sets the associated value of *string* to *value*. *value* must be a
+ valid UTF-8 encoded Unicode string. Returns 0 on success and -1 on
+ error.
+
+ .. versionadded:: 1.1
Number
@@ -210,10 +217,17 @@ Number
Returns a new JSON integer, or *NULL* on error.
-.. cfunction:: int json_integer_value(const json_t *json)
+.. cfunction:: int json_integer_value(const json_t *integer)
+
+ Returns the associated value of *integer*, or 0 if *json* is not a
+ JSON integer.
+
+.. cfunction:: int json_integer_set(const json_t *integer, int value)
- Returns the associated value the JSON integer *json*. If *json* is
- *NULL* or not a JSON integer, 0 is returned.
+ Sets the associated value of *integer* to *value*. Returns 0 on
+ success and -1 if *integer* is not a JSON integer.
+
+ .. versionadded:: 1.1
.. cfunction:: json_t *json_real(double value)
@@ -221,10 +235,17 @@ Number
Returns a new JSON real, or *NULL* on error.
-.. cfunction:: double json_real_value(const json_t *json)
+.. cfunction:: double json_real_value(const json_t *real)
+
+ Returns the associated value of *real*, or 0.0 if *real* is not a
+ JSON real.
- Returns the associated value of the JSON real *json*. If *json* is
- *NULL* or not a JSON real, 0.0 is returned.
+.. cfunction:: int json_real_set(const json_t *real, double value)
+
+ Sets the associated value of *real* to *value*. Returns 0 on
+ success and -1 if *real* is not a JSON real.
+
+ .. versionadded:: 1.1
In addition to the functions above, there's a common query function
for integers and reals: