summaryrefslogtreecommitdiffhomepage
path: root/include/mruby.h
diff options
context:
space:
mode:
authorFelix Jones <[email protected]>2016-11-06 13:19:14 +0000
committerFelix Jones <[email protected]>2016-11-06 13:19:14 +0000
commitcc5f40b2dbcd8e0ea703e820dcf203619b5f1003 (patch)
tree2e94301f486de3b5b3425ec75b405ebf3db9ec60 /include/mruby.h
parent8d6aa06548929000d98004f5bcbb57bfd1afd4e9 (diff)
downloadmruby-cc5f40b2dbcd8e0ea703e820dcf203619b5f1003.tar.gz
mruby-cc5f40b2dbcd8e0ea703e820dcf203619b5f1003.zip
mrb_class_under_defined docs renamed parent and child to outer and inner
Diffstat (limited to 'include/mruby.h')
-rw-r--r--include/mruby.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/include/mruby.h b/include/mruby.h
index a603a316d..886b15e50 100644
--- a/include/mruby.h
+++ b/include/mruby.h
@@ -567,18 +567,18 @@ MRB_API mrb_bool mrb_class_defined(mrb_state *mrb, const char *name);
MRB_API struct RClass * mrb_class_get(mrb_state *mrb, const char *name);
/**
- * Returns an mrb_bool. True if child class was defined, and false if the child class was not defined.
+ * Returns an mrb_bool. True if inner class was defined, and false if the inner class was not defined.
*
* Example:
* void
* mrb_example_gem_init(mrb_state* mrb) {
- * struct RClass *example_parent, *example_child;
+ * struct RClass *example_outer, *example_inner;
* mrb_bool cd;
*
- * example_parent = mrb_define_module(mrb, "ExampleParent");
+ * example_outer = mrb_define_module(mrb, "ExampleOuter");
*
- * example_child = mrb_define_class(mrb, "ExampleChild", mrb->object_class);
- * cd = mrb_class_under_defined(mrb, example_parent, "ExampleChild");
+ * example_inner = mrb_define_class_under(mrb, example_outer, "ExampleInner", mrb->object_class);
+ * cd = mrb_class_under_defined(mrb, example_outer, "ExampleInner");
*
* // If mrb_class_under_defined returns 1 then puts "True"
* // If mrb_class_under_defined returns 0 then puts "False"
@@ -591,8 +591,8 @@ MRB_API struct RClass * mrb_class_get(mrb_state *mrb, const char *name);
* }
*
* @param [mrb_state*] mrb The current mruby state.
- * @param [struct RClass *] outer The name of the parent class.
- * @param [const char *] name A string representing the name of the child class.
+ * @param [struct RClass *] outer The name of the outer class.
+ * @param [const char *] name A string representing the name of the inner class.
* @return [mrb_bool] A boolean value.
*/
MRB_API mrb_bool mrb_class_under_defined(mrb_state *mrb, struct RClass *outer, const char *name);