From: andy5995 <andy400-dev@yahoo.com>
Date: Tue, 27 Nov 2018 17:35:45 +0000 (-0600)
Subject: json_object.h:document json_object_new_string_len()
X-Git-Tag: json-c-0.14-20200419~106^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3b108935d0f92df49ec79cfcb6189e982302ebca;p=thirdparty%2Fjson-c.git

json_object.h:document json_object_new_string_len()

I also added a couple trivial, but related, suggestions.

closes #460
---

diff --git a/json_object.c b/json_object.c
index 8a86bc6e..c5dd1b4c 100644
--- a/json_object.c
+++ b/json_object.c
@@ -1030,7 +1030,7 @@ struct json_object* json_object_new_string(const char *s)
 	return jso;
 }
 
-struct json_object* json_object_new_string_len(const char *s, int len)
+struct json_object* json_object_new_string_len(const char *s, const int len)
 {
 	char *dstbuf;
 	struct json_object *jso = json_object_new(json_type_string);
diff --git a/json_object.h b/json_object.h
index a0263203..f7acaf70 100644
--- a/json_object.h
+++ b/json_object.h
@@ -899,10 +899,21 @@ JSON_EXPORT int json_object_set_double(struct json_object *obj,double new_value)
  *
  * @param s the string
  * @returns a json_object of type json_type_string
+ * @see json_object_new_string_len()
  */
 JSON_EXPORT struct json_object* json_object_new_string(const char *s);
 
-JSON_EXPORT struct json_object* json_object_new_string_len(const char *s, int len);
+/** Create a new empty json_object of type json_type_string and allocate
+ * len characters for the new string.
+ *
+ * A copy of the string is made and the memory is managed by the json_object
+ *
+ * @param[in] s the string
+ * @param[in] len max length of the new string
+ * @returns a json_object of type json_type_string
+ * @see json_object_new_string()
+ */
+JSON_EXPORT struct json_object* json_object_new_string_len(const char *s, const int len);
 
 /** Get the string value of a json_object
  *