Documentation fixes

This commit is contained in:
panzhe committed 2026-09-09 11:22:11 +08:00
1 parent befb5a0b26
commit 0dd8a021d7
3 files changed
+5 -4

No files matched your search

+1 -1
View File
@@ -265,7 +265,7 @@ JSON_EXPORT void *json_object_get_userdata(json_object *jso);
* *
* Note: Objects created by parsing strings may have custom serializers set * Note: Objects created by parsing strings may have custom serializers set
* which expect the userdata to contain specific data (due to use of * which expect the userdata to contain specific data (due to use of
* json_object_new_double_s()). In this case, json_object_set_serialiser() with * json_object_new_double_s()). In this case, json_object_set_serializer() with
* NULL as to_string_func should be used instead to set the userdata and reset * NULL as to_string_func should be used instead to set the userdata and reset
* the serializer to its default value. * the serializer to its default value.
* *
+2 -1
View File
@@ -84,7 +84,8 @@ JSON_EXPORT struct json_object_iterator json_object_iter_init_default(void);
* Modifications include adding or removing any pair, even if * Modifications include adding or removing any pair, even if
* set of keys appears unchanged after the modification. * set of keys appears unchanged after the modification.
* Modifying *values* is allowed, including replacing a value * Modifying *values* is allowed, including replacing a value
* by calling json_object_add(), provided the key already exists. * by calling json_object_object_add(), provided the key already
* exists.
* Attempting to use an invalidated iterator in any way, other * Attempting to use an invalidated iterator in any way, other
* than comparing it to the end iterator, is *undefined behavior*. * than comparing it to the end iterator, is *undefined behavior*.
* Passing such an iterator to any of the the json_object_iterator * Passing such an iterator to any of the the json_object_iterator
+2 -2
View File
@@ -295,7 +295,7 @@ extern json_bool lh_table_lookup_ex(struct lh_table *t, const void *k, void **v)
* Delete a record from the table. * Delete a record from the table.
* *
* If a callback free function is provided then it is called for the * If a callback free function is provided then it is called for the
* for the item being deleted. * item being deleted.
* @param t the table to delete from. * @param t the table to delete from.
* @param e a pointer to the entry to delete. * @param e a pointer to the entry to delete.
* @return 0 if the item was deleted. * @return 0 if the item was deleted.
@@ -318,7 +318,7 @@ extern int lh_table_delete_entry_to_tail(struct lh_table *t, struct lh_entry *e)
* Delete a record from the table. * Delete a record from the table.
* *
* If a callback free function is provided then it is called for the * If a callback free function is provided then it is called for the
* for the item being deleted. * item being deleted.
* @param t the table to delete from. * @param t the table to delete from.
* @param k a pointer to the key to delete. * @param k a pointer to the key to delete.
* @return 0 if the item was deleted. * @return 0 if the item was deleted.