Commit 91444aec authored by Ralph Desir(Mav7)'s avatar Ralph Desir(Mav7)

fixed YARD documentation for mrb_obj_new

parent 12c24e0e
......@@ -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 # => #<ExampleClass:0x9958588>
* // C style
* #include <stdio.h>
* #include <mruby.h>
*
* 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 <stdio.h>
* #include <mruby.h>
*
* 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); // => #<ExampleClass:0x89734f8>
* 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);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment