diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2018-03-12 22:17:17 +0900 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2018-03-16 08:18:52 +0900 |
| commit | ec390e8f1ba37f50d2fec46899739edc591fd34c (patch) | |
| tree | 102fd7744c30858c44ae7f349a6f426a8143876d /include/mruby.h | |
| parent | 6c84e6e4a55b6f3c41cc0d2d2d75e83d33c59d1e (diff) | |
| download | mruby-ec390e8f1ba37f50d2fec46899739edc591fd34c.tar.gz mruby-ec390e8f1ba37f50d2fec46899739edc591fd34c.zip | |
Update `mrb_get_args` reference comment; ref #3963
Diffstat (limited to 'include/mruby.h')
| -rw-r--r-- | include/mruby.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/mruby.h b/include/mruby.h index 3e13050b6..b424c20ae 100644 --- a/include/mruby.h +++ b/include/mruby.h @@ -829,22 +829,22 @@ MRB_API struct RClass * mrb_define_module_under(mrb_state *mrb, struct RClass *o * * Must be a C string composed of the following format specifiers: * - * | char | Ruby type | C types | Notes | + * | char | Ruby type | C types | Notes | * |:----:|----------------|-------------------|----------------------------------------------------| * | `o` | {Object} | {mrb_value} | Could be used to retrieve any type of argument | * | `C` | {Class}/{Module} | {mrb_value} | | * | `S` | {String} | {mrb_value} | when `!` follows, the value may be `nil` | * | `A` | {Array} | {mrb_value} | when `!` follows, the value may be `nil` | * | `H` | {Hash} | {mrb_value} | when `!` follows, the value may be `nil` | - * | `s` | {String} | char *, {mrb_int} | Receive two arguments; `s!` gives (`NULL`,`0`) for `nil` | + * | `s` | {String} | char *, {mrb_int} | Receive two arguments; `s!` gives (`NULL`,`0`) for `nil` | * | `z` | {String} | char * | `NULL` terminated string; `z!` gives `NULL` for `nil` | * | `a` | {Array} | {mrb_value} *, {mrb_int} | Receive two arguments; `a!` gives (`NULL`,`0`) for `nil` | * | `f` | {Float} | {mrb_float} | | * | `i` | {Integer} | {mrb_int} | | * | `b` | boolean | {mrb_bool} | | * | `n` | {Symbol} | {mrb_sym} | | - * | `&` | block | {mrb_value} | when &! gives raised exception if no block given. | - * | `*` | rest arguments | {mrb_value} *, {mrb_int} | Receive the rest of arguments as an array. | + * | `&` | block | {mrb_value} | &! raises exception if no block given. | + * | `*` | rest arguments | {mrb_value} *, {mrb_int} | Receive the rest of arguments as an array; *! avoid copy of the stack. | * | | | optional | | After this spec following specs would be optional. | * | `?` | optional given | {mrb_bool} | `TRUE` if preceding argument is given. Used to check optional argument is given. | * |