summaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-21 14:50:04 -0300
committerSeba Gamboa <[email protected]>2015-09-21 14:50:04 -0300
commit0e5b81539990a6b87913ed73cb37f0640a39e5a6 (patch)
tree00b1251514e16fbbd333e2c354fb4d941d7f57eb /include
parentdd925578c604a608f83172f85d8e5bfc3bb99c6a (diff)
downloadmruby-0e5b81539990a6b87913ed73cb37f0640a39e5a6.tar.gz
mruby-0e5b81539990a6b87913ed73cb37f0640a39e5a6.zip
Document data header
Diffstat (limited to 'include')
-rw-r--r--include/mruby/data.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/include/mruby/data.h b/include/mruby/data.h
index 8fd798455..c68b050f7 100644
--- a/include/mruby/data.h
+++ b/include/mruby/data.h
@@ -11,14 +11,23 @@
/**
* @file mruby/data.h
- * @defgroup mruby_data User defined objects.
+ * @defgroup mruby_data Custom C wrapped data.
+ *
+ * Defining Ruby wrappers around native objects.
+ *
* @ingroup mruby
* @{
*/
MRB_BEGIN_DECL
+/**
+ * Custom data type description.
+ */
typedef struct mrb_data_type {
+ /** data type name */
const char *struct_name;
+
+ /** data type release function pointer */
void (*dfree)(mrb_state *mrb, void*);
} mrb_data_type;