summaryrefslogtreecommitdiffhomepage
path: root/include/mruby.h
diff options
context:
space:
mode:
authorDavid Siaw <[email protected]>2019-08-18 14:53:24 +0900
committerDavid Siaw <[email protected]>2019-08-18 20:12:44 +0900
commitb5299b1c5832a4eb9d6c6becfab76d76570c91ab (patch)
tree96cc9f5671aa6b92149bc2946e3e24d79774599c /include/mruby.h
parent2c868954684e9e83c8b84ce0747bbb3e928d3143 (diff)
downloadmruby-b5299b1c5832a4eb9d6c6becfab76d76570c91ab.tar.gz
mruby-b5299b1c5832a4eb9d6c6becfab76d76570c91ab.zip
fix up documentation for values
Diffstat (limited to 'include/mruby.h')
-rw-r--r--include/mruby.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/mruby.h b/include/mruby.h
index 55505a213..6ac15715e 100644
--- a/include/mruby.h
+++ b/include/mruby.h
@@ -25,6 +25,10 @@
** [ MIT license: http://www.opensource.org/licenses/mit-license.php ]
*/
+/**
+ * @file mruby.h
+ */
+
#ifndef MRUBY_H
#define MRUBY_H
@@ -97,11 +101,14 @@ MRB_BEGIN_DECL
typedef uint8_t mrb_code;
/**
- * Required arguments signature type.
+ * \class mrb_aspec
+ *
+ * Specifies the number of arguments a function takes
+ *
+ * Example: `MRB_ARGS_REQ(2) | MRB_ARGS_OPT(1)` for a method that expects 2..3 arguments
*/
typedef uint32_t mrb_aspec;
-
struct mrb_irep;
struct mrb_state;