From c2732a160a2da0451a35d13ffb1ac24e98d042e4 Mon Sep 17 00:00:00 2001 From: yui-knk Date: Tue, 6 May 2014 12:41:23 +0900 Subject: Add a comment to ObjectSpace.each_object. --- mrbgems/mruby-objectspace/src/mruby_objectspace.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'mrbgems/mruby-objectspace/src/mruby_objectspace.c') diff --git a/mrbgems/mruby-objectspace/src/mruby_objectspace.c b/mrbgems/mruby-objectspace/src/mruby_objectspace.c index 7d3b0b74e..eccc652e2 100644 --- a/mrbgems/mruby-objectspace/src/mruby_objectspace.c +++ b/mrbgems/mruby-objectspace/src/mruby_objectspace.c @@ -128,6 +128,20 @@ os_each_object_cb(mrb_state *mrb, struct RBasic *obj, void *ud) ++d->count; } +/* + * call-seq: + * ObjectSpace.each_object([module]) {|obj| ... } -> fixnum + * + * Calls the block once for each object in this Ruby process. + * Returns the number of objects found. + * If the optional argument +module+ is given, + * calls the block for only those classes or modules + * that match (or are a subclass of) +module+. + * + * If no block is given, ArgumentError is raised. + * + */ + static mrb_value os_each_object(mrb_state *mrb, mrb_value self) { -- cgit v1.2.3