From: Eric Haszlakiewicz <erh+git@nimenees.com>
Date: Sun, 1 Apr 2012 03:47:47 +0000 (-0500)
Subject: Mention json_type_to_name() in the docs for json_object_get_type().
X-Git-Tag: json-c-0.10-20120530~27
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6ff0817bac01f070dbae172df0bb01d617e2fae2;p=thirdparty%2Fjson-c.git

Mention json_type_to_name() in the docs for json_object_get_type().
---

diff --git a/json_object.h b/json_object.h
index e9898f41..72a87088 100644
--- a/json_object.h
+++ b/json_object.h
@@ -90,7 +90,9 @@ extern void json_object_put(struct json_object *obj);
 extern int json_object_is_type(struct json_object *obj, enum json_type type);
 
 /**
- * Get the type of the json_object
+ * Get the type of the json_object.  See also json_type_to_name() to turn this
+ * into a string suitable, for instance, for logging.
+ *
  * @param obj the json_object instance
  * @returns type being one of:
      json_type_null (i.e. obj == NULL),