summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authordearblue <[email protected]>2019-09-29 11:49:15 +0900
committerdearblue <[email protected]>2019-09-29 11:49:15 +0900
commitf6d3d675abb06032f80ac1ff2abe1c7deb76fd44 (patch)
tree8dc35feb2c2756c66ff6a4448a02d64a817a8ba3
parent19e4f56c679790f2ed2f11fb18f653ec506030e2 (diff)
downloadmruby-f6d3d675abb06032f80ac1ff2abe1c7deb76fd44.tar.gz
mruby-f6d3d675abb06032f80ac1ff2abe1c7deb76fd44.zip
Add an annotation about the return value
-rw-r--r--include/mruby/hash.h2
1 files changed, 1 insertions, 1 deletions
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);