Commit f6d3d675 authored by dearblue's avatar dearblue

Add an annotation about the return value

parent 19e4f56c
...@@ -95,7 +95,7 @@ MRB_API mrb_value mrb_hash_fetch(mrb_state *mrb, mrb_value hash, mrb_value key, ...@@ -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 mrb The mruby state reference.
* @param hash The target hash. * @param hash The target hash.
* @param key The key to delete. * @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); MRB_API mrb_value mrb_hash_delete_key(mrb_state *mrb, mrb_value hash, mrb_value key);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment