From f6d3d675abb06032f80ac1ff2abe1c7deb76fd44 Mon Sep 17 00:00:00 2001 From: dearblue Date: Sun, 29 Sep 2019 11:49:15 +0900 Subject: Add an annotation about the return value --- include/mruby/hash.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/mruby/hash.h b/include/mruby/hash.h index 48a858e0e..e75a769fd 100644 --- a/include/mruby/hash.h +++ b/include/mruby/hash.h @@ -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); -- cgit v1.2.3