summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-10-14 12:49:17 -0300
committerSeba Gamboa <[email protected]>2015-10-20 12:16:46 -0300
commit84b70886cd9827593810264bf1f068044d5c6986 (patch)
tree1abe840c121cfce396c641d3207ac827ed98d5b2
parentfe1275a6afc587a1034afa708477dad466a53b94 (diff)
downloadmruby-84b70886cd9827593810264bf1f068044d5c6986.tar.gz
mruby-84b70886cd9827593810264bf1f068044d5c6986.zip
Add block to document mrb_value type
-rw-r--r--include/mruby/value.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/mruby/value.h b/include/mruby/value.h
index dfad3ec73..002ea8511 100644
--- a/include/mruby/value.h
+++ b/include/mruby/value.h
@@ -98,6 +98,22 @@ enum mrb_vtype {
#include "mruby/object.h"
+#ifdef MRB_DOCUMENTATION_BLOCK
+
+/**
+ * @abstract
+ * MRuby value boxing.
+ *
+ * Actual implementation depends on configured boxing type.
+ *
+ * @see mruby/boxing_no.h Default boxing representation
+ * @see mruby/boxing_word.h Word representation
+ * @see mruby/boxing_nan.h Boxed double representation
+ */
+typedef void mrb_value;
+
+#endif
+
#if defined(MRB_NAN_BOXING)
#include "boxing_nan.h"
#elif defined(MRB_WORD_BOXING)