From d16912681a13a2dc6d5e1779bf36b67debce2a55 Mon Sep 17 00:00:00 2001 From: "Ralph Desir(Mav7)" Date: Thu, 15 Oct 2015 19:41:45 -0400 Subject: updated YARD docs on mruby.h --- include/mruby.h | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) (limited to 'include/mruby.h') diff --git a/include/mruby.h b/include/mruby.h index cecf6fa47..efdd45a87 100644 --- a/include/mruby.h +++ b/include/mruby.h @@ -496,6 +496,21 @@ MRB_API void mrb_undef_class_method(mrb_state*, struct RClass*, const char*); /** * Initialize a new object instace of c class. * + * // Example: + * #include + * #include + * + * void + * mrb_example_gem_init(mrb_state* mrb) { + * struct RClass *example_class; + * + * mrb_value *argv[1]; + * mrb_value obj; + * + * example_class = mrb_define_class(mrb, "ExampleClass", mrb->object_class);* argv[0] = example_class; + * obj = mrb_obj_new(mrb, mrb->object_class, 1, argv); // => ExampleClass + * mrb_funcall(mrb, obj, "puts", 1, example_class); + * } * @param mrb The current mruby state. * @param c Reference to the class of the new object. * @param argc Number of arguments in argv @@ -504,7 +519,31 @@ MRB_API void mrb_undef_class_method(mrb_state*, struct RClass*, const char*); */ MRB_API mrb_value mrb_obj_new(mrb_state *mrb, struct RClass *c, mrb_int argc, const mrb_value *argv); -/** @see mrb_obj_new */ +/** + * Initialize a new object instace of c class. + * + * // Example: + * #include + * #include + * + * void + * mrb_example_gem_init(mrb_state* mrb) { + * struct RClass *example_class; + * + * mrb_value *argv[1]; + * mrb_value obj; + * mrb_value obj_inst; + * + * example_class = mrb_define_class(mrb, "ExampleClass", mrb->object_class);* + * argv[0] = example_class; + * obj = mrb_obj_new(mrb, mrb->object_class, 1, argv); + * obj_inst = mrb_class_new_instance(mrb, 0, argv, example_class); // => # + * mrb_funcall(mrb, obj, "puts", 1, obj_inst); + * } + * @param mrb The current mruby state. + * @param argc Number of arguments in argv + * @param c Reference to the class of the new object. + */ MRB_INLINE mrb_value mrb_class_new_instance(mrb_state *mrb, mrb_int argc, const mrb_value *argv, struct RClass *c) { return mrb_obj_new(mrb,c,argc,argv); -- cgit v1.2.3 From 91444aec4bb7d336a6a5043ca1b6b0a8d3291742 Mon Sep 17 00:00:00 2001 From: "Ralph Desir(Mav7)" Date: Sat, 17 Oct 2015 03:10:28 -0400 Subject: fixed YARD documentation for mrb_obj_new --- include/mruby.h | 41 ++++++++++------------------------------- 1 file changed, 10 insertions(+), 31 deletions(-) (limited to 'include/mruby.h') diff --git a/include/mruby.h b/include/mruby.h index efdd45a87..a427de29d 100644 --- a/include/mruby.h +++ b/include/mruby.h @@ -496,20 +496,23 @@ MRB_API void mrb_undef_class_method(mrb_state*, struct RClass*, const char*); /** * Initialize a new object instace of c class. * - * // Example: + * # Ruby style + * class ExampleClass + * end + * + * p ExampleClass # => # + * // C style * #include * #include * * void * mrb_example_gem_init(mrb_state* mrb) { * struct RClass *example_class; - * - * mrb_value *argv[1]; * mrb_value obj; * - * example_class = mrb_define_class(mrb, "ExampleClass", mrb->object_class);* argv[0] = example_class; - * obj = mrb_obj_new(mrb, mrb->object_class, 1, argv); // => ExampleClass - * mrb_funcall(mrb, obj, "puts", 1, example_class); + * example_class = mrb_define_class(mrb, "ExampleClass", mrb->object_class); # => class ExampleClass; end + * obj = mrb_obj_new(mrb, example_class, 0, NULL); # => ExampleClass.new + * mrb_p(mrb, obj); // => Kernel#p * } * @param mrb The current mruby state. * @param c Reference to the class of the new object. @@ -519,31 +522,7 @@ MRB_API void mrb_undef_class_method(mrb_state*, struct RClass*, const char*); */ MRB_API mrb_value mrb_obj_new(mrb_state *mrb, struct RClass *c, mrb_int argc, const mrb_value *argv); -/** - * Initialize a new object instace of c class. - * - * // Example: - * #include - * #include - * - * void - * mrb_example_gem_init(mrb_state* mrb) { - * struct RClass *example_class; - * - * mrb_value *argv[1]; - * mrb_value obj; - * mrb_value obj_inst; - * - * example_class = mrb_define_class(mrb, "ExampleClass", mrb->object_class);* - * argv[0] = example_class; - * obj = mrb_obj_new(mrb, mrb->object_class, 1, argv); - * obj_inst = mrb_class_new_instance(mrb, 0, argv, example_class); // => # - * mrb_funcall(mrb, obj, "puts", 1, obj_inst); - * } - * @param mrb The current mruby state. - * @param argc Number of arguments in argv - * @param c Reference to the class of the new object. - */ +/** @see mrb_obj_new */ MRB_INLINE mrb_value mrb_class_new_instance(mrb_state *mrb, mrb_int argc, const mrb_value *argv, struct RClass *c) { return mrb_obj_new(mrb,c,argc,argv); -- cgit v1.2.3