diff options
author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2020-11-30 12:18:21 +0900 |
---|---|---|
committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2020-11-30 12:18:21 +0900 |
commit | 7e1dbe59759247ae0df26ef3f669009f00e058fd (patch) | |
tree | 98d4a6ba8abaaff7a2da38afb5218fdafcdc475b /st.c | |
parent | b408d32bf2f8c7f952691388ad1307cf99019882 (diff) |
[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.
Diffstat (limited to 'st.c')
-rw-r--r-- | st.c | 17 |
1 files changed, 9 insertions, 8 deletions
@@ -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 - value of the found entry, and non-zero as the 3rd argument. If the - entry is not found, call FUNC with KEY, and 2 zero arguments. If - the call returns ST_CONTINUE, the table will have an entry with key - and value returned by FUNC through the 1st and 2nd parameters. If - the call of FUNC returns ST_DELETE, the table will not have entry - with KEY. The function returns flag of that the entry with KEY was - in the table before the call. */ +/* Find entry with KEY in table TAB, call FUNC with pointers to copies + of the key and the value of the found entry, and non-zero as the + 3rd argument. If the entry is not found, call FUNC with a pointer + to KEY, a pointer to zero, and a zero argument. If the call + returns ST_CONTINUE, the table will have an entry with key and + value returned by FUNC through the 1st and 2nd parameters. If the + call of FUNC returns ST_DELETE, the table will not have entry with + KEY. The function returns flag of that the entry with KEY was in + the table before the call. */ int st_update(st_table *tab, st_data_t key, st_update_callback_func *func, st_data_t arg) |