Add an annotation of the return value from mrb_delete_key; #4737

The return value from `mrb_delete_key` needs to be protected from GC in
some cases.
This commit is contained in:
Yukihiro "Matz" Matsumoto
2019-09-29 13:50:37 +09:00
parent acbea6affe
commit bbfd64d01b
+1 -1
View File
@@ -95,7 +95,7 @@ MRB_API mrb_value mrb_hash_fetch(mrb_state *mrb, mrb_value hash, mrb_value key,
* @param mrb The mruby state reference.
* @param hash The target hash.
* @param key The key to delete.
* @return The deleted value.
* @return The deleted value. This value is not protected from GC. Use `mrb_gc_protect()` if necessary.
*/
MRB_API mrb_value mrb_hash_delete_key(mrb_state *mrb, mrb_value hash, mrb_value key);