add description comment to mrb_fiber_yield()

80c343ae · Yukihiro "Matz" Matsumoto · 9248cdd6 · 80c343ae
Commit 80c343ae authored Feb 19, 2015 by Yukihiro "Matz" Matsumoto
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 0 deletions

mrbgems/mruby-fiber/src/fiber.c mrbgems/mruby-fiber/src/fiber.c +2 -0

No files found.
--- a/mrbgems/mruby-fiber/src/fiber.c
+++ b/mrbgems/mruby-fiber/src/fiber.c
@@ -291,6 +291,8 @@ fiber_transfer(mrb_state *mrb, mrb_value self)
  return fiber_switch(mrb, self, len, a, FALSE);
 }

+/* yield values to the caller fiber */
+/* mrb_fiber_yield() must be called as `return mrb_fiber_yield(...)` */
 MRB_API mrb_value
 mrb_fiber_yield(mrb_state *mrb, mrb_int len, const mrb_value *a)
 {