]> git.ipfire.org Git - thirdparty/json-c.git/commitdiff
Mention json_type_to_name() in the docs for json_object_get_type().
authorEric Haszlakiewicz <erh+git@nimenees.com>
Sun, 1 Apr 2012 03:47:47 +0000 (22:47 -0500)
committerKeith Derrick <keith.derrick@palm.com>
Mon, 2 Apr 2012 14:53:25 +0000 (07:53 -0700)
json_object.h

index e9898f41ed552322f9b007d08fb849571c4c461d..72a870887d93cdc23f9d4f73b2111595a5e922a2 100644 (file)
@@ -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),