From: Petri Lehtinen <petri@digip.org>
Date: Mon, 20 Dec 2010 19:08:04 +0000 (+0200)
Subject: Emphasize the constness of the return value of json_string_value()
X-Git-Tag: v2.0~33
X-Git-Url: http://www.project-moonshot.org/gitweb/?p=jansson.git;a=commitdiff_plain;h=269e86b72572a6ba546270e8d22409efc40c2fbd

Emphasize the constness of the return value of json_string_value()

Closes GH-7.
---

diff --git a/doc/apiref.rst b/doc/apiref.rst
index e37cb8c..dcc0cbf 100644
--- a/doc/apiref.rst
+++ b/doc/apiref.rst
@@ -306,6 +306,10 @@ U+10FFFF are allowed.
    Returns the associated value of *string* as a null terminated UTF-8
    encoded string, or *NULL* if *string* is not a JSON string.
 
+   The retuned value is read-only and must not be modified or freed by
+   the user. It is valid as long as *string* exists, i.e. as long as
+   its reference count has not dropped to zero.
+
 .. function:: int json_string_set(const json_t *string, const char *value)
 
    Sets the associated value of *string* to *value*. *value* must be a