summaryrefslogtreecommitdiff
path: root/json_object_iterator.h
diff options
context:
space:
mode:
authorEric Haszlakiewicz <erh+git@nimenees.com>2017-12-05 18:25:03 -0500
committerEric Haszlakiewicz <erh+git@nimenees.com>2017-12-05 18:43:18 -0500
commitd6d81e6ece30def7a3977d191f70dcd80bc29b1b (patch)
tree68f673ae9fc0d829d4993edd75948d7f87bf877e /json_object_iterator.h
parentc01635e03eb94e14ba7d39970f298a4379b4fa04 (diff)
downloadjson-c-d6d81e6ece30def7a3977d191f70dcd80bc29b1b.tar.gz
Adjust the description of json_object_iterator a bit.
Diffstat (limited to 'json_object_iterator.h')
-rw-r--r--json_object_iterator.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/json_object_iterator.h b/json_object_iterator.h
index 44c9fb2..f226cbd 100644
--- a/json_object_iterator.h
+++ b/json_object_iterator.h
@@ -7,10 +7,11 @@
* This library is free software; you can redistribute it and/or modify
* it under the terms of the MIT license. See COPYING for details.
*
-* @brief json-c forces clients to use its private data
-* structures for JSON Object iteration. This API
-* corrects that by abstracting the private json-c
-* details.
+* @brief An API for iterating over json_type_object objects,
+* styled to be familiar to C++ programmers.
+* Unlike json_object_object_foreach() and
+* json_object_object_foreachC(), this avoids the need to expose
+* json-c internals like lh_entry.
*
* API attributes: <br>
* * Thread-safe: NO<br>