From: Eric Haszlakiewicz <erh+git@nimenees.com>
Date: Sun, 12 Jul 2020 17:55:46 +0000 (+0000)
Subject: Expand the doc for json_object_array_get_idx() to explain that it does not adjust... 
X-Git-Tag: json-c-0.15-20200726~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2330c6f0de57356066881e1cdf1194ec03cdf01e;p=thirdparty%2Fjson-c.git

Expand the doc for json_object_array_get_idx() to explain that it does not adjust refcounts.
---

diff --git a/json_object.h b/json_object.h
index 909c4369..4121bf56 100644
--- a/json_object.h
+++ b/json_object.h
@@ -593,7 +593,15 @@ JSON_EXPORT int json_object_array_add(struct json_object *obj, struct json_objec
 JSON_EXPORT int json_object_array_put_idx(struct json_object *obj, size_t idx,
                                           struct json_object *val);
 
-/** Get the element at specified index of the array (a json_object of type json_type_array)
+/** Get the element at specified index of array `obj` (which must be a json_object of type json_type_array)
+ *
+ * *No* reference counts will be changed, and ownership of the returned
+ * object remains with `obj`.  See json_object_object_get() for additional
+ * implications of this behavior.
+ *
+ * Calling this with anything other than a json_type_array will trigger
+ * an assert.
+ *
  * @param obj the json_object instance
  * @param idx the index to get the element at
  * @returns the json_object at the specified index (or NULL)