From 06a765a1c244b0201a54cfeece77c2f33a62e504 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Wed, 3 May 2023 22:12:59 +1000 Subject: [PATCH] Change `MRuby` to `mruby` --- CONTRIBUTING.md | 2 +- include/mruby.h | 14 +++++++------- include/mruby/common.h | 2 +- include/mruby/compile.h | 2 +- include/mruby/debug.h | 2 +- include/mruby/error.h | 2 +- include/mruby/value.h | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a59463e77..888d9d463 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,7 +113,7 @@ unless there's a clear reason, e.g. the latest Ruby has changed behavior from IS ### mruby API - [YARD](https://yardoc.org/) - YARD is a documentation generation tool for the Ruby programming language -- [yard-mruby](https://rubygems.org/gems/yard-mruby) - Document MRuby sources with YARD +- [yard-mruby](https://rubygems.org/gems/yard-mruby) - Document mruby sources with YARD - [yard-coderay](https://rubygems.org/gems/yard-coderay) - Adds coderay syntax highlighting to YARD docs ### C API diff --git a/include/mruby.h b/include/mruby.h index 71e3a6361..76c1f2fcb 100644 --- a/include/mruby.h +++ b/include/mruby.h @@ -139,7 +139,7 @@ #endif /** - * MRuby C API entry point + * mruby C API entry point */ MRB_BEGIN_DECL @@ -420,7 +420,7 @@ MRB_API void mrb_prepend_module(mrb_state *mrb, struct RClass *cla, struct RClas * mrb_define_method(mrb, mrb->kernel_module, "example_method", example_method, MRB_ARGS_NONE()); * } * - * @param mrb The MRuby state reference. + * @param mrb The mruby state reference. * @param cla The class pointer where the method will be defined. * @param name The name of the method being defined. * @param func The function pointer to the method definition. @@ -448,7 +448,7 @@ MRB_API void mrb_define_method_id(mrb_state *mrb, struct RClass *c, mrb_sym mid, * foo = mrb_define_class(mrb, "Foo", mrb->object_class); * mrb_define_class_method(mrb, foo, "bar", bar_method, MRB_ARGS_NONE()); * } - * @param mrb The MRuby state reference. + * @param mrb The mruby state reference. * @param cla The class where the class method will be defined. * @param name The name of the class method being defined. * @param fun The function pointer to the class method definition. @@ -484,7 +484,7 @@ MRB_API void mrb_define_singleton_method_id(mrb_state *mrb, struct RObject *cla, * foo = mrb_define_module(mrb, "Foo"); * mrb_define_module_function(mrb, foo, "bar", bar_method, MRB_ARGS_NONE()); * } - * @param mrb The MRuby state reference. + * @param mrb The mruby state reference. * @param cla The module where the module function will be defined. * @param name The name of the module function being defined. * @param fun The function pointer to the module function definition. @@ -514,7 +514,7 @@ MRB_API void mrb_define_module_function_id(mrb_state *mrb, struct RClass *cla, m * mrb_value * mrb_example_gem_final(mrb_state* mrb){ * } - * @param mrb The MRuby state reference. + * @param mrb The mruby state reference. * @param cla A class or module the constant is defined in. * @param name The name of the constant being defined. * @param val The value for the constant. @@ -1017,7 +1017,7 @@ struct mrb_kwargs /** * Retrieve arguments from mrb_state. * - * @param mrb The current MRuby state. + * @param mrb The current mruby state. * @param format is a list of format specifiers * @param ... The passing variadic arguments must be a pointer of retrieving type. * @return the number of arguments retrieved. @@ -1248,7 +1248,7 @@ MRB_API mrb_state* mrb_open(void); MRB_API mrb_state* mrb_open_allocf(mrb_allocf f, void *ud); /** - * Create new mrb_state with just the MRuby core + * Create new mrb_state with just the mruby core * * @param f * Reference to the allocation function. diff --git a/include/mruby/common.h b/include/mruby/common.h index 59214d3c1..fd5c11022 100644 --- a/include/mruby/common.h +++ b/include/mruby/common.h @@ -67,7 +67,7 @@ MRB_BEGIN_DECL #endif #define MRB_INLINE static inline -/** Declare a public MRuby API function. */ +/** Declare a public mruby API function. */ #ifndef MRB_API #if defined(MRB_BUILD_AS_DLL) #if defined(MRB_CORE) || defined(MRB_LIB) diff --git a/include/mruby/compile.h b/include/mruby/compile.h index 70cf9a93b..84f09e3e2 100644 --- a/include/mruby/compile.h +++ b/include/mruby/compile.h @@ -10,7 +10,7 @@ #include "common.h" /** - * MRuby Compiler + * mruby Compiler */ MRB_BEGIN_DECL diff --git a/include/mruby/debug.h b/include/mruby/debug.h index e42a9124d..f0409351b 100644 --- a/include/mruby/debug.h +++ b/include/mruby/debug.h @@ -10,7 +10,7 @@ #include "common.h" /** - * MRuby Debugging. + * mruby Debugging. */ MRB_BEGIN_DECL diff --git a/include/mruby/error.h b/include/mruby/error.h index 46166ec54..5f7ec43bd 100644 --- a/include/mruby/error.h +++ b/include/mruby/error.h @@ -10,7 +10,7 @@ #include "common.h" /** - * MRuby error handling. + * mruby error handling. */ MRB_BEGIN_DECL diff --git a/include/mruby/value.h b/include/mruby/value.h index 6666a9c14..dea55c5a3 100644 --- a/include/mruby/value.h +++ b/include/mruby/value.h @@ -10,7 +10,7 @@ #include "common.h" /* - * MRuby Value definition functions and macros. + * mruby Value definition functions and macros. */ MRB_BEGIN_DECL @@ -186,7 +186,7 @@ MRB_VTYPE_FOREACH(MRB_VTYPE_TYPEDEF) /** * @abstract - * MRuby value boxing. + * mruby value boxing. * * Actual implementation depends on configured boxing type. *