[DOC] Fixed st_udpate comment [ci skip]

Clarified that the first and second arguments to the callback
function are pointers to the KEY and the VALUE, but not those
values themselves.
This commit is contained in:
Nobuyoshi Nakada 2020-11-30 12:18:21 +09:00
parent b408d32bf2
commit 7e1dbe5975
No known key found for this signature in database
GPG Key ID: 7CD2805BFA3770C6

17
st.c
View File

@ -1368,14 +1368,15 @@ st_cleanup_safe(st_table *tab ATTRIBUTE_UNUSED,
{ {
} }
/* Find entry with KEY in table TAB, call FUNC with the key and the /* Find entry with KEY in table TAB, call FUNC with pointers to copies
value of the found entry, and non-zero as the 3rd argument. If the of the key and the value of the found entry, and non-zero as the
entry is not found, call FUNC with KEY, and 2 zero arguments. If 3rd argument. If the entry is not found, call FUNC with a pointer
the call returns ST_CONTINUE, the table will have an entry with key to KEY, a pointer to zero, and a zero argument. If the call
and value returned by FUNC through the 1st and 2nd parameters. If returns ST_CONTINUE, the table will have an entry with key and
the call of FUNC returns ST_DELETE, the table will not have entry value returned by FUNC through the 1st and 2nd parameters. If the
with KEY. The function returns flag of that the entry with KEY was call of FUNC returns ST_DELETE, the table will not have entry with
in the table before the call. */ KEY. The function returns flag of that the entry with KEY was in
the table before the call. */
int int
st_update(st_table *tab, st_data_t key, st_update(st_table *tab, st_data_t key,
st_update_callback_func *func, st_data_t arg) st_update_callback_func *func, st_data_t arg)