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

kdopen · Apr 2, 2012 · 23d0da5 · 23d0da5
1 parent 7c4a964
commit 23d0da5
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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),