Adding memsize_of_all doc

a79d1ba9 · Rory OConnell · fe1ec9af · a79d1ba9
Commit a79d1ba9 authored Jul 17, 2020 by Rory OConnell
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

mrbgems/mruby-objectspace/src/mruby_objectspace.c mrbgems/mruby-objectspace/src/mruby_objectspace.c +8 -0

No files found.
--- a/mrbgems/mruby-objectspace/src/mruby_objectspace.c
+++ b/mrbgems/mruby-objectspace/src/mruby_objectspace.c
@@ -357,6 +357,14 @@ os_memsize_of_all_cb(mrb_state *mrb, struct RBasic *obj, void *d)
  return 0;
 }

+/*
+ *  call-seq:
+ *    ObjectSpace.memsize_of_all([klass]) -> Numeric
+ *
+ *  Return consuming memory size of all living objects of type klass.
+ *
+ */
+
 static mrb_value
 os_memsize_of_all(mrb_state *mrb, mrb_value self)
 {