add documentation to funcs

recp · Aug 25, 2019 · 57511e5 · 57511e5
1 parent 4159555
commit 57511e5
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 4 deletions.
diff --git a/include/json/impl/impl_json.h b/include/json/impl/impl_json.h
@@ -316,7 +316,7 @@ void
 json_array_float(float        * __restrict dest,
                  const json_t * __restrict object,
                  float                     defaultValue,
-                 int                       maxLength,
+                 int                       maxCount,
                  bool                      sourceIsReversed) {
   json_array_t *arr;
   json_t       *item;
@@ -328,8 +328,8 @@ json_array_float(float        * __restrict dest,
   count = arr->count;
   item  = arr->base.value;
 
-  if (maxLength > 0 && count > maxLength)
-    count = maxLength;
+  if (maxCount > 0 && count > maxCount)
+    count = maxCount;
 
   if (sourceIsReversed) {
     while (item) {

diff --git a/include/json/json.h b/include/json/json.h
@@ -73,20 +73,47 @@ JSON_INLINE
 json_array_t*
 json_array(const json_t * __restrict object);
 
+/*!
+ * @brief returns count of array's items
+ *
+ * @param[in] object json object
+ * @return count
+ */
 JSON_INLINE
 int
 json_count(const json_t * __restrict object);
 
+/*!
+ * @brief returns true if object is array
+ *
+ * @param[in] object json object
+ * @return true if object is array otherwise false
+ */
 JSON_INLINE
 bool
 json_is_array(const json_t * __restrict object);
 
+/*!
+ * @brief fill float array
+ *
+ * if you know item is float array, you don't need to iterate manulally.
+ * with maxCount you can trim array from start, for instance if array is vec4
+ * and you want to get vec3, then if you set maxCount as 3, you will only get
+ * first 3 items of array
+ *
+ * @param[in] dest              destination float array
+ * @param[in] object            json object
+ * @param[in] defaultValue      defult value if item is not float
+ * @param[in] maxCount          max count to read, 0 to read all
+ * @param[in] sourceIsReversed  source is reversed; true if you pass true to
+ *                              json_parse's reverse parameter
+ */
 JSON_INLINE
 void
 json_array_float(float        * __restrict dest,
                  const json_t * __restrict object,
                  float                     defaultValue,
-                 int                       maxLength,
+                 int                       maxCount,
                  bool                      sourceIsReversed);
 
 #include "impl/impl_json.h"