diff options
| author | Seba Gamboa <[email protected]> | 2015-10-09 17:43:47 -0300 |
|---|---|---|
| committer | Seba Gamboa <[email protected]> | 2015-10-20 12:16:46 -0300 |
| commit | e871b77f417538dc181ef69d497262786d96f5c0 (patch) | |
| tree | 79257a856d2282a79df2f292d35e6335ed653fa7 /include | |
| parent | fc4f0b9be7133dc901d02bb938e90ffd1487e50a (diff) | |
| download | mruby-e871b77f417538dc181ef69d497262786d96f5c0.tar.gz mruby-e871b77f417538dc181ef69d497262786d96f5c0.zip | |
Increasing docs coverage
Diffstat (limited to 'include')
| -rw-r--r-- | include/mruby.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/include/mruby.h b/include/mruby.h index d50ec3496..7ed4973e2 100644 --- a/include/mruby.h +++ b/include/mruby.h @@ -887,9 +887,26 @@ MRB_API mrb_value mrb_attr_get(mrb_state *mrb, mrb_value obj, mrb_sym id); MRB_API mrb_bool mrb_respond_to(mrb_state *mrb, mrb_value obj, mrb_sym mid); MRB_API mrb_bool mrb_obj_is_instance_of(mrb_state *mrb, mrb_value obj, struct RClass* c); -/* fiber functions (you need to link mruby-fiber mrbgem to use) */ + +/* + * Resume a Fiber + * + * @mrbgem mruby-fiber + */ MRB_API mrb_value mrb_fiber_resume(mrb_state *mrb, mrb_value fib, mrb_int argc, const mrb_value *argv); + +/* + * Yield a Fiber + * + * @mrbgem mruby-fiber + */ MRB_API mrb_value mrb_fiber_yield(mrb_state *mrb, mrb_int argc, const mrb_value *argv); + +/* + * FiberError reference + * + * @mrbgem mruby-fiber + */ #define E_FIBER_ERROR (mrb_class_get(mrb, "FiberError")) /* memory pool implementation */ |
