Document data header

0e5b8153 · Seba Gamboa · dd925578 · 0e5b8153
Commit 0e5b8153 authored Sep 21, 2015 by Seba Gamboa
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 1 deletion

include/mruby/data.h include/mruby/data.h +10 -1

No files found.
--- 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;