ruby-sdl2 0.3.5 → 0.3.7

data/gl.c

@@ -12,8 +12,6 @@ typedef struct GLContext {
     SDL_GLContext context;
 } GLContext;
 
-DEFINE_WRAPPER(SDL_GLContext, GLContext, context, cGLContext, "SDL2::GL::Context");
-
 static void GLContext_free(GLContext* c)
 {
     if (c->context)
@@ -21,11 +19,16 @@ static void GLContext_free(GLContext* c)
     free(c);
 }
 
+DEFINE_DATA_TYPE(GLContext, GLContext_free);
+
+DEFINE_WRAPPER(SDL_GLContext, GLContext, context, cGLContext, "SDL2::GL::Context");
+
 static VALUE GLContext_new(SDL_GLContext context)
 {
-    GLContext* c = ALLOC(GLContext);
+    GLContext* c;
+    VALUE obj = TypedData_Make_Struct(cGLContext, GLContext, &GLContext_data_type, c);
     c->context = context;
-    return Data_Wrap_Struct(cGLContext, 0, GLContext_free, c);
+    return obj;
 }
 
 /*
@@ -115,8 +118,7 @@ static VALUE GLContext_make_current(VALUE self, VALUE window)
 /*
  * Get the current OpenGL context.
  *
- * @return [SDL2::GL::Context] the curren context
- * @return [nil] if there is no current context
+ * @return [SDL2::GL::Context,nil] the current context, nil if there is no current context
  *
  * @see #make_current
  */
@@ -130,6 +132,7 @@ static VALUE GLContext_s_current(VALUE self)
  *   Return true if the current context supports **extension**
  *
  *   @param extension [String] the name of an extension
+ *   @return [Boolean] 
  *   @example
  *     SDL2::GL.extension_supported?("GL_EXT_framebuffer_blit")
  */
@@ -190,7 +193,7 @@ static VALUE GL_s_get_attribute(VALUE self, VALUE attr)
  *   
  *   @param attr [Integer] the OpenGL attribute to set
  *   @param value [Integer] the desired value for the attribute
- *   @return [value]
+ *   @return [void]
  */
 static VALUE GL_s_set_attribute(VALUE self, VALUE attr, VALUE value)
 {
@@ -217,56 +220,48 @@ void rubysdl2_init_gl(void)
     rb_define_module_function(mGL, "set_attribute", GL_s_set_attribute, 2);
 
     /*  */
-    /* OpenGL attribute - minimal bits of red channel in color buffer, default is 3 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of red channel in color buffer, default is 3 */
     rb_define_const(mGL, "RED_SIZE", INT2NUM(SDL_GL_RED_SIZE));
-    /* OpenGL attribute - minimal bits of green channel in color buffer, default is 3 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of green channel in color buffer, default is 3 */
     rb_define_const(mGL, "GREEN_SIZE", INT2NUM(SDL_GL_GREEN_SIZE));
-    /* OpenGL attribute - minimal bits of blue channel in color buffer, default is 2 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of blue channel in color buffer, default is 2 */
     rb_define_const(mGL, "BLUE_SIZE", INT2NUM(SDL_GL_BLUE_SIZE));
-    /* OpenGL attribute - minimal bits of alpha channel in color buffer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of alpha channel in color buffer, default is 0 */
     rb_define_const(mGL, "ALPHA_SIZE", INT2NUM(SDL_GL_ALPHA_SIZE));
-    /* OpenGL attribute - minimal bits of framebufer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of framebufer, default is 0 */
     rb_define_const(mGL, "BUFFER_SIZE", INT2NUM(SDL_GL_BUFFER_SIZE));
-    /* OpenGL attribute - whether the single buffer (0) or double buffer (1), default
-       is double buffer */
+    /* @return [Integer] index for OpenGL attribute - whether the single buffer (0) or double buffer (1), default is double buffer */
     rb_define_const(mGL, "DOUBLEBUFFER", INT2NUM(SDL_GL_DOUBLEBUFFER));
-    /* OpenGL attribute - bits of depth buffer, default is 16 */
+    /* @return [Integer] index for OpenGL attribute - bits of depth buffer, default is 16 */
     rb_define_const(mGL, "DEPTH_SIZE", INT2NUM(SDL_GL_DEPTH_SIZE));
-    /* OpenGL attribute - bits of stencil buffer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - bits of stencil buffer, default is 0 */
     rb_define_const(mGL, "STENCIL_SIZE", INT2NUM(SDL_GL_STENCIL_SIZE));
-    /* OpenGL attribute - minimal bits of red channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of red channel in accumlation buffer, default is 0 */
     rb_define_const(mGL, "ACCUM_RED_SIZE", INT2NUM(SDL_GL_ACCUM_RED_SIZE));
-    /* OpenGL attribute - minimal bits of green channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of green channel in accumlation buffer, default is 0 */
     rb_define_const(mGL, "ACCUM_GREEN_SIZE", INT2NUM(SDL_GL_ACCUM_GREEN_SIZE));
-    /* OpenGL attribute - minimal bits of blue channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of blue channel in accumlation buffer, default is 0 */
     rb_define_const(mGL, "ACCUM_BLUE_SIZE", INT2NUM(SDL_GL_ACCUM_BLUE_SIZE));
-    /* OpenGL attribute - minimal bits of alpha channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of alpha channel in accumlation buffer, default is 0 */
     rb_define_const(mGL, "ACCUM_ALPHA_SIZE", INT2NUM(SDL_GL_ACCUM_ALPHA_SIZE));
-    /* OpenGL attribute - whether output is stereo (1) or not (0), default is 0 */
+    /* @return [Integer] index for OpenGL attribute - whether output is stereo (1) or not (0), default is 0 */
     rb_define_const(mGL, "STEREO", INT2NUM(SDL_GL_STEREO));
-    /* OpenGL attribuite - the number of buffers used for multisampe anti-aliasing,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribuite - the number of buffers used for multisampe anti-aliasing, default is 0 */
     rb_define_const(mGL, "MULTISAMPLEBUFFERS", INT2NUM(SDL_GL_MULTISAMPLEBUFFERS));
-    /* OpenGL attribute - the number of samples used around the current pixel
-       use for multisample anti-aliasing, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - the number of samples used around the current pixel use for multisample anti-aliasing, default is 0 */
     rb_define_const(mGL, "MULTISAMPLESAMPLES", INT2NUM(SDL_GL_MULTISAMPLESAMPLES));
-    /* OpenGL attribute - 1 for requiring hardware acceleration, 0 for software rendering,
-       default is allowing either */
+    /* @return [Integer] index for OpenGL attribute - 1 for requiring hardware acceleration, 0 for software rendering, default is allowing either */
     rb_define_const(mGL, "ACCELERATED_VISUAL", INT2NUM(SDL_GL_ACCELERATED_VISUAL));
-    /* OpenGL attribute - not used (deprecated) */
+    /* @return [Integer] index for OpenGL attribute - not used (deprecated) */
     rb_define_const(mGL, "RETAINED_BACKING", INT2NUM(SDL_GL_RETAINED_BACKING));
-    /* OpenGL attribute - OpenGL context major version */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context major version */
     rb_define_const(mGL, "CONTEXT_MAJOR_VERSION", INT2NUM(SDL_GL_CONTEXT_MAJOR_VERSION));
-    /* OpenGL attribute - OpenGL context minor version */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context minor version */
     rb_define_const(mGL, "CONTEXT_MINOR_VERSION", INT2NUM(SDL_GL_CONTEXT_MINOR_VERSION));
     /*
      * INT2NUM(SDL_GL_CONTEXT_FLAGS):
      * 
-     * OpenGL attribute - the bit combination of following constants, or 0.
+     * @return [Integer] index for OpenGL attribute - the bit combination of following constants, or 0.
      * default is 0
      *
      * * {SDL2::GL::CONTEXT_DEBUG_FLAG}
@@ -282,7 +277,7 @@ void rubysdl2_init_gl(void)
     rb_define_const(mGL, "CONTEXT_FLAGS", INT2NUM(SDL_GL_CONTEXT_FLAGS));
     /* INT2NUM(SDL_GL_CONTEXT_PROFILE_MASK):
      *
-     * OpenGL attribute - type of GL context, one of the following constants,
+     * @return [Integer] index for OpenGL attribute - type of GL context, one of the following constants,
      * defaults depends on platform
      *
      * * {CONTEXT_PROFILE_CORE}
@@ -292,58 +287,59 @@ void rubysdl2_init_gl(void)
      * https://wiki.libsdl.org/SDL_GLprofile
      */
     rb_define_const(mGL, "CONTEXT_PROFILE_MASK", INT2NUM(SDL_GL_CONTEXT_PROFILE_MASK));
-    /* OpenGL attribute - OpenGL context sharing, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context sharing, default is 0 */
     rb_define_const(mGL, "SHARE_WITH_CURRENT_CONTEXT", INT2NUM(SDL_GL_SHARE_WITH_CURRENT_CONTEXT));
 #if SDL_VERSION_ATLEAST(2,0,1)
-    /* OpenGL attribute - 1 for requesting sRGB capable visual, default to 0 */
+    /* @return [Integer] index for OpenGL attribute - 1 for requesting sRGB capable visual, default to 0 */
     rb_define_const(mGL, "FRAMEBUFFER_SRGB_CAPABLE", INT2NUM(SDL_GL_FRAMEBUFFER_SRGB_CAPABLE));
 #endif
-    /* OpenGL attribute - not used (deprecated) */
+    /* @return [Integer] index for OpenGL attribute - not used (deprecated) */
     rb_define_const(mGL, "CONTEXT_EGL", INT2NUM(SDL_GL_CONTEXT_EGL));
 
     /*  */
 
-    /* This flag maps to GLX_CONTEXT_DEBUG_BIT_ARB in
-     * the GLX_ARB_create_context extension for X11
-     * and WGL_CONTEXT_DEBUG_BIT_ARB in the WGL_ARB_create_context
-     * extension for Windows.
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_DEBUG_BIT_ARB in
+     *   the GLX_ARB_create_context extension for X11
+     *   and WGL_CONTEXT_DEBUG_BIT_ARB in the WGL_ARB_create_context
+     *   extension for Windows.
      */
     rb_define_const(mGL, "CONTEXT_DEBUG_FLAG", INT2NUM(SDL_GL_CONTEXT_DEBUG_FLAG));
-    /*
-     * This flag maps to GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the
-     * GLX_ARB_create_context extension for X11 and
-     * WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the WGL_ARB_create_context
-     * extension for Windows.
+    /* @return [Integer] 
+     *   This flag maps to GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the
+     *   GLX_ARB_create_context extension for X11 and
+     *   WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the WGL_ARB_create_context
+     *   extension for Windows.
      */
     rb_define_const(mGL, "CONTEXT_FORWARD_COMPATIBLE_FLAG", INT2NUM(SDL_GL_CONTEXT_FORWARD_COMPATIBLE_FLAG));
-    /*
-     * This flag maps to GLX_CONTEXT_ROBUST_ACCESS_BIT_ARB in the
-     * GLX_ARB_create_context_robustness extension for X11 and
-     * WGL_CONTEXT_ROBUST_ACCESS_BIT_ARB in the WGL_ARB_create_context_robustness
-     * extension for Windows. 
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_ROBUST_ACCESS_BIT_ARB in the
+     *   GLX_ARB_create_context_robustness extension for X11 and
+     *   WGL_CONTEXT_ROBUST_ACCESS_BIT_ARB in the WGL_ARB_create_context_robustness
+     *   extension for Windows. 
      */
     rb_define_const(mGL, "CONTEXT_ROBUST_ACCESS_FLAG", INT2NUM(SDL_GL_CONTEXT_ROBUST_ACCESS_FLAG));
-    /*
-     * This flag maps to GLX_CONTEXT_RESET_ISOLATION_BIT_ARB in the
-     * GLX_ARB_robustness_isolation extension for X11 and
-     * WGL_CONTEXT_RESET_ISOLATION_BIT_ARB in the WGL_ARB_create_context_robustness
-     * extension for Windows.
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_RESET_ISOLATION_BIT_ARB in the
+     *   GLX_ARB_robustness_isolation extension for X11 and
+     *   WGL_CONTEXT_RESET_ISOLATION_BIT_ARB in the WGL_ARB_create_context_robustness
+     *   extension for Windows.
      */
     rb_define_const(mGL, "CONTEXT_RESET_ISOLATION_FLAG", INT2NUM(SDL_GL_CONTEXT_RESET_ISOLATION_FLAG));
 
-    /*
-     * OpenGL core profile - deprecated
-     * functions are disabled
+    /* @return [Integer]
+     *   OpenGL core profile - deprecated
+     *   functions are disabled
      */
     rb_define_const(mGL, "CONTEXT_PROFILE_CORE", INT2NUM(SDL_GL_CONTEXT_PROFILE_CORE));
-    /*
-     * OpenGL compatibility profile -
-     * deprecated functions are allowed
+    /* @return [Integer]
+     *   OpenGL compatibility profile -
+     *   deprecated functions are allowed
      */
     rb_define_const(mGL, "CONTEXT_PROFILE_COMPATIBILITY", INT2NUM(SDL_GL_CONTEXT_PROFILE_COMPATIBILITY));
-    /*
-     * OpenGL ES profile - only a subset of the
-     * base OpenGL functionality is available
+    /* @return [Integer]
+     *   OpenGL ES profile - only a subset of the
+     *   base OpenGL functionality is available
      */
     rb_define_const(mGL, "CONTEXT_PROFILE_ES", INT2NUM(SDL_GL_CONTEXT_PROFILE_ES));
     

data/gl.c.m4

@@ -12,8 +12,6 @@ typedef struct GLContext {
     SDL_GLContext context;
 } GLContext;
 
-DEFINE_WRAPPER(SDL_GLContext, GLContext, context, cGLContext, "SDL2::GL::Context");
-
 static void GLContext_free(GLContext* c)
 {
     if (c->context)
@@ -21,11 +19,16 @@ static void GLContext_free(GLContext* c)
     free(c);
 }
 
+DEFINE_DATA_TYPE(GLContext, GLContext_free);
+
+DEFINE_WRAPPER(SDL_GLContext, GLContext, context, cGLContext, "SDL2::GL::Context");
+
 static VALUE GLContext_new(SDL_GLContext context)
 {
-    GLContext* c = ALLOC(GLContext);
+    GLContext* c;
+    VALUE obj = TypedData_Make_Struct(cGLContext, GLContext, &GLContext_data_type, c);
     c->context = context;
-    return Data_Wrap_Struct(cGLContext, 0, GLContext_free, c);
+    return obj;
 }
 
 /*
@@ -115,8 +118,7 @@ static VALUE GLContext_make_current(VALUE self, VALUE window)
 /*
  * Get the current OpenGL context.
  *
- * @return [SDL2::GL::Context] the curren context
- * @return [nil] if there is no current context
+ * @return [SDL2::GL::Context,nil] the current context, nil if there is no current context
  *
  * @see #make_current
  */
@@ -130,6 +132,7 @@ static VALUE GLContext_s_current(VALUE self)
  *   Return true if the current context supports **extension**
  *
  *   @param extension [String] the name of an extension
+ *   @return [Boolean] 
  *   @example
  *     SDL2::GL.extension_supported?("GL_EXT_framebuffer_blit")
  */
@@ -190,7 +193,7 @@ static VALUE GL_s_get_attribute(VALUE self, VALUE attr)
  *   
  *   @param attr [Integer] the OpenGL attribute to set
  *   @param value [Integer] the desired value for the attribute
- *   @return [value]
+ *   @return [void]
  */
 static VALUE GL_s_set_attribute(VALUE self, VALUE attr, VALUE value)
 {
@@ -217,56 +220,48 @@ void rubysdl2_init_gl(void)
     rb_define_module_function(mGL, "set_attribute", GL_s_set_attribute, 2);
 
     /* define(`DEFINE_GL_ATTR_CONST',`rb_define_const(mGL, "$1", INT2NUM(SDL_GL_$1))') */
-    /* OpenGL attribute - minimal bits of red channel in color buffer, default is 3 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of red channel in color buffer, default is 3 */
     DEFINE_GL_ATTR_CONST(RED_SIZE);
-    /* OpenGL attribute - minimal bits of green channel in color buffer, default is 3 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of green channel in color buffer, default is 3 */
     DEFINE_GL_ATTR_CONST(GREEN_SIZE);
-    /* OpenGL attribute - minimal bits of blue channel in color buffer, default is 2 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of blue channel in color buffer, default is 2 */
     DEFINE_GL_ATTR_CONST(BLUE_SIZE);
-    /* OpenGL attribute - minimal bits of alpha channel in color buffer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of alpha channel in color buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(ALPHA_SIZE);
-    /* OpenGL attribute - minimal bits of framebufer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of framebufer, default is 0 */
     DEFINE_GL_ATTR_CONST(BUFFER_SIZE);
-    /* OpenGL attribute - whether the single buffer (0) or double buffer (1), default
-       is double buffer */
+    /* @return [Integer] index for OpenGL attribute - whether the single buffer (0) or double buffer (1), default is double buffer */
     DEFINE_GL_ATTR_CONST(DOUBLEBUFFER);
-    /* OpenGL attribute - bits of depth buffer, default is 16 */
+    /* @return [Integer] index for OpenGL attribute - bits of depth buffer, default is 16 */
     DEFINE_GL_ATTR_CONST(DEPTH_SIZE);
-    /* OpenGL attribute - bits of stencil buffer, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - bits of stencil buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(STENCIL_SIZE);
-    /* OpenGL attribute - minimal bits of red channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of red channel in accumlation buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(ACCUM_RED_SIZE);
-    /* OpenGL attribute - minimal bits of green channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of green channel in accumlation buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(ACCUM_GREEN_SIZE);
-    /* OpenGL attribute - minimal bits of blue channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of blue channel in accumlation buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(ACCUM_BLUE_SIZE);
-    /* OpenGL attribute - minimal bits of alpha channel in accumlation buffer,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribute - minimal bits of alpha channel in accumlation buffer, default is 0 */
     DEFINE_GL_ATTR_CONST(ACCUM_ALPHA_SIZE);
-    /* OpenGL attribute - whether output is stereo (1) or not (0), default is 0 */
+    /* @return [Integer] index for OpenGL attribute - whether output is stereo (1) or not (0), default is 0 */
     DEFINE_GL_ATTR_CONST(STEREO);
-    /* OpenGL attribuite - the number of buffers used for multisampe anti-aliasing,
-       default is 0 */
+    /* @return [Integer] index for OpenGL attribuite - the number of buffers used for multisampe anti-aliasing, default is 0 */
     DEFINE_GL_ATTR_CONST(MULTISAMPLEBUFFERS);
-    /* OpenGL attribute - the number of samples used around the current pixel
-       use for multisample anti-aliasing, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - the number of samples used around the current pixel use for multisample anti-aliasing, default is 0 */
     DEFINE_GL_ATTR_CONST(MULTISAMPLESAMPLES);
-    /* OpenGL attribute - 1 for requiring hardware acceleration, 0 for software rendering,
-       default is allowing either */
+    /* @return [Integer] index for OpenGL attribute - 1 for requiring hardware acceleration, 0 for software rendering, default is allowing either */
     DEFINE_GL_ATTR_CONST(ACCELERATED_VISUAL);
-    /* OpenGL attribute - not used (deprecated) */
+    /* @return [Integer] index for OpenGL attribute - not used (deprecated) */
     DEFINE_GL_ATTR_CONST(RETAINED_BACKING);
-    /* OpenGL attribute - OpenGL context major version */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context major version */
     DEFINE_GL_ATTR_CONST(CONTEXT_MAJOR_VERSION);
-    /* OpenGL attribute - OpenGL context minor version */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context minor version */
     DEFINE_GL_ATTR_CONST(CONTEXT_MINOR_VERSION);
     /*
      * INT2NUM(SDL_GL_CONTEXT_FLAGS):
      * 
-     * OpenGL attribute - the bit combination of following constants, or 0.
+     * @return [Integer] index for OpenGL attribute - the bit combination of following constants, or 0.
      * default is 0
      *
      * * {SDL2::GL::CONTEXT_DEBUG_FLAG}
@@ -282,7 +277,7 @@ void rubysdl2_init_gl(void)
     DEFINE_GL_ATTR_CONST(CONTEXT_FLAGS);
     /* INT2NUM(SDL_GL_CONTEXT_PROFILE_MASK):
      *
-     * OpenGL attribute - type of GL context, one of the following constants,
+     * @return [Integer] index for OpenGL attribute - type of GL context, one of the following constants,
      * defaults depends on platform
      *
      * * {CONTEXT_PROFILE_CORE}
@@ -292,58 +287,59 @@ void rubysdl2_init_gl(void)
      * https://wiki.libsdl.org/SDL_GLprofile
      */
     DEFINE_GL_ATTR_CONST(CONTEXT_PROFILE_MASK);
-    /* OpenGL attribute - OpenGL context sharing, default is 0 */
+    /* @return [Integer] index for OpenGL attribute - OpenGL context sharing, default is 0 */
     DEFINE_GL_ATTR_CONST(SHARE_WITH_CURRENT_CONTEXT);
 #if SDL_VERSION_ATLEAST(2,0,1)
-    /* OpenGL attribute - 1 for requesting sRGB capable visual, default to 0 */
+    /* @return [Integer] index for OpenGL attribute - 1 for requesting sRGB capable visual, default to 0 */
     DEFINE_GL_ATTR_CONST(FRAMEBUFFER_SRGB_CAPABLE);
 #endif
-    /* OpenGL attribute - not used (deprecated) */
+    /* @return [Integer] index for OpenGL attribute - not used (deprecated) */
     DEFINE_GL_ATTR_CONST(CONTEXT_EGL);
 
     /* define(`DEFINE_GL_CONTEXT_CONST',`rb_define_const(mGL, "CONTEXT_$1", INT2NUM(SDL_GL_CONTEXT_$1))') */
 
-    /* This flag maps to GLX_CONTEXT_DEBUG_BIT_ARB in
-     * the GLX_ARB_create_context extension for X11
-     * and WGL_CONTEXT_DEBUG_BIT_ARB in the WGL_ARB_create_context
-     * extension for Windows.
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_DEBUG_BIT_ARB in
+     *   the GLX_ARB_create_context extension for X11
+     *   and WGL_CONTEXT_DEBUG_BIT_ARB in the WGL_ARB_create_context
+     *   extension for Windows.
      */
     DEFINE_GL_CONTEXT_CONST(DEBUG_FLAG);
-    /*
-     * This flag maps to GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the
-     * GLX_ARB_create_context extension for X11 and
-     * WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the WGL_ARB_create_context
-     * extension for Windows.
+    /* @return [Integer] 
+     *   This flag maps to GLX_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the
+     *   GLX_ARB_create_context extension for X11 and
+     *   WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB in the WGL_ARB_create_context
+     *   extension for Windows.
      */
     DEFINE_GL_CONTEXT_CONST(FORWARD_COMPATIBLE_FLAG);
-    /*
-     * This flag maps to GLX_CONTEXT_ROBUST_ACCESS_BIT_ARB in the
-     * GLX_ARB_create_context_robustness extension for X11 and
-     * WGL_CONTEXT_ROBUST_ACCESS_BIT_ARB in the WGL_ARB_create_context_robustness
-     * extension for Windows. 
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_ROBUST_ACCESS_BIT_ARB in the
+     *   GLX_ARB_create_context_robustness extension for X11 and
+     *   WGL_CONTEXT_ROBUST_ACCESS_BIT_ARB in the WGL_ARB_create_context_robustness
+     *   extension for Windows. 
      */
     DEFINE_GL_CONTEXT_CONST(ROBUST_ACCESS_FLAG);
-    /*
-     * This flag maps to GLX_CONTEXT_RESET_ISOLATION_BIT_ARB in the
-     * GLX_ARB_robustness_isolation extension for X11 and
-     * WGL_CONTEXT_RESET_ISOLATION_BIT_ARB in the WGL_ARB_create_context_robustness
-     * extension for Windows.
+    /* @return [Integer]
+     *   This flag maps to GLX_CONTEXT_RESET_ISOLATION_BIT_ARB in the
+     *   GLX_ARB_robustness_isolation extension for X11 and
+     *   WGL_CONTEXT_RESET_ISOLATION_BIT_ARB in the WGL_ARB_create_context_robustness
+     *   extension for Windows.
      */
     DEFINE_GL_CONTEXT_CONST(RESET_ISOLATION_FLAG);
 
-    /*
-     * OpenGL core profile - deprecated
-     * functions are disabled
+    /* @return [Integer]
+     *   OpenGL core profile - deprecated
+     *   functions are disabled
      */
     DEFINE_GL_CONTEXT_CONST(PROFILE_CORE);
-    /*
-     * OpenGL compatibility profile -
-     * deprecated functions are allowed
+    /* @return [Integer]
+     *   OpenGL compatibility profile -
+     *   deprecated functions are allowed
      */
     DEFINE_GL_CONTEXT_CONST(PROFILE_COMPATIBILITY);
-    /*
-     * OpenGL ES profile - only a subset of the
-     * base OpenGL functionality is available
+    /* @return [Integer]
+     *   OpenGL ES profile - only a subset of the
+     *   base OpenGL functionality is available
      */
     DEFINE_GL_CONTEXT_CONST(PROFILE_ES);
     

data/hint.c

@@ -88,11 +88,11 @@ void rubysdl2_init_hints(void)
     rb_define_singleton_method(mHints, "get", Hints_s_aref, 1);
     rb_define_singleton_method(mHints, "[]=", Hints_s_aset, -1);
 
-    /* low priority, used fro default values */
+    /* @return [Integer] index for low priority, used fro default values */
     rb_define_const(mHints, "DEFAULT", INT2NUM(SDL_HINT_DEFAULT));
-    /* medium priority, overrided by an environment variable */
+    /* @return [Integer] index for medium priority, overrided by an environment variable */
     rb_define_const(mHints, "NORMAL", INT2NUM(SDL_HINT_NORMAL));
-    /* high priority, this priority overrides the value by environment variables */
+    /* @return [Integer] index for high priority, this priority overrides the value by environment variables */
     rb_define_const(mHints, "OVERRIDE", INT2NUM(SDL_HINT_OVERRIDE));
 
     sym_priority = ID2SYM(rb_intern("priority"));

data/joystick.c

@@ -18,11 +18,14 @@ static void Joystick_free(Joystick* j)
     free(j);
 }
 
+DEFINE_DATA_TYPE(Joystick, Joystick_free);
+
 static VALUE Joystick_new(SDL_Joystick* joystick)
 {
-    Joystick* j = ALLOC(Joystick);
+    Joystick* j;
+    VALUE obj = TypedData_Make_Struct(cJoystick, Joystick, &Joystick_data_type, j);
     j->joystick = joystick;
-    return Data_Wrap_Struct(cJoystick, 0, Joystick_free, j);
+    return obj;
 }
 
 DEFINE_WRAPPER(SDL_Joystick, Joystick, joystick, cJoystick, "SDL2::Joystick");
@@ -99,6 +102,7 @@ static VALUE Joystick_s_open(VALUE self, VALUE device_index)
  *   interface.
  *
  *   @param [Integer] index the joystick device index
+ *   @return [Boolean]
  *   @see SDL2::GameController
  * 
  */
@@ -225,7 +229,7 @@ static VALUE Joystick_axis(VALUE self, VALUE which)
  *   Get the current state of a trackball on a joystick.
  *   
  *   @param [Integer] which an index of a trackball, started at index 0
- *   @return [[Integer,Integer]] dx and dy
+ *   @return [Array(Integer,Integer)] dx and dy
  *   @see #num_balls
  */
 static VALUE Joystick_ball(VALUE self, VALUE which)
@@ -309,23 +313,23 @@ void rubysdl2_init_joystick(void)
     mHat = rb_define_module_under(cJoystick, "Hat");
     
     /*  */
-    /* Center position. Equal to 0. */
+    /* @return [Integer] hat state\: Center position. Equal to 0. */
     rb_define_const(mHat, "CENTERED", INT2NUM(SDL_HAT_CENTERED));
-    /* Up position. */
+    /* @return [Integer] hat state\: Up position. */
     rb_define_const(mHat, "UP", INT2NUM(SDL_HAT_UP));
-    /* Right position. */
+    /* @return [Integer] hat state\: Right position. */
     rb_define_const(mHat, "RIGHT", INT2NUM(SDL_HAT_RIGHT));
-    /* Down position. */
+    /* @return [Integer] hat state\: Down position. */
     rb_define_const(mHat, "DOWN", INT2NUM(SDL_HAT_DOWN));
-    /* Left position. */
+    /* @return [Integer] hat state\: Left position. */
     rb_define_const(mHat, "LEFT", INT2NUM(SDL_HAT_LEFT));
-    /* Right Up position. Equal to ({RIGHT} | {UP}) */
+    /* @return [Integer] hat state\: Right Up position. Equal to ({RIGHT} | {UP}) */
     rb_define_const(mHat, "RIGHTUP", INT2NUM(SDL_HAT_RIGHTUP));
-    /* Right Down position. Equal to ({RIGHT} | {DOWN}) */
+    /* @return [Integer] hat state\: Right Down position. Equal to ({RIGHT} | {DOWN}) */
     rb_define_const(mHat, "RIGHTDOWN", INT2NUM(SDL_HAT_RIGHTDOWN));
-    /* Left Up position. Equal to ({LEFT} | {UP}) */
+    /* @return [Integer] hat state\: Left Up position. Equal to ({LEFT} | {UP}) */
     rb_define_const(mHat, "LEFTUP", INT2NUM(SDL_HAT_LEFTUP));
-    /* Left Down position. Equal to ({LEFT} | {DOWN}) */
+    /* @return [Integer] hat state\: Left Down position. Equal to ({LEFT} | {DOWN}) */
     rb_define_const(mHat, "LEFTDOWN", INT2NUM(SDL_HAT_LEFTDOWN));
 
     /* Device GUID

data/joystick.c.m4

@@ -18,11 +18,14 @@ static void Joystick_free(Joystick* j)
     free(j);
 }
 
+DEFINE_DATA_TYPE(Joystick, Joystick_free);
+
 static VALUE Joystick_new(SDL_Joystick* joystick)
 {
-    Joystick* j = ALLOC(Joystick);
+    Joystick* j;
+    VALUE obj = TypedData_Make_Struct(cJoystick, Joystick, &Joystick_data_type, j);
     j->joystick = joystick;
-    return Data_Wrap_Struct(cJoystick, 0, Joystick_free, j);
+    return obj;
 }
 
 DEFINE_WRAPPER(SDL_Joystick, Joystick, joystick, cJoystick, "SDL2::Joystick");
@@ -99,6 +102,7 @@ static VALUE Joystick_s_open(VALUE self, VALUE device_index)
  *   interface.
  *
  *   @param [Integer] index the joystick device index
+ *   @return [Boolean]
  *   @see SDL2::GameController
  * 
  */
@@ -225,7 +229,7 @@ static VALUE Joystick_axis(VALUE self, VALUE which)
  *   Get the current state of a trackball on a joystick.
  *   
  *   @param [Integer] which an index of a trackball, started at index 0
- *   @return [[Integer,Integer]] dx and dy
+ *   @return [Array(Integer,Integer)] dx and dy
  *   @see #num_balls
  */
 static VALUE Joystick_ball(VALUE self, VALUE which)
@@ -309,23 +313,23 @@ void rubysdl2_init_joystick(void)
     mHat = rb_define_module_under(cJoystick, "Hat");
     
     /* define(`DEFINE_JOY_HAT_CONST',`rb_define_const(mHat, "$1", INT2NUM(SDL_HAT_$1))') */
-    /* Center position. Equal to 0. */
+    /* @return [Integer] hat state\: Center position. Equal to 0. */
     DEFINE_JOY_HAT_CONST(CENTERED);
-    /* Up position. */
+    /* @return [Integer] hat state\: Up position. */
     DEFINE_JOY_HAT_CONST(UP);
-    /* Right position. */
+    /* @return [Integer] hat state\: Right position. */
     DEFINE_JOY_HAT_CONST(RIGHT);
-    /* Down position. */
+    /* @return [Integer] hat state\: Down position. */
     DEFINE_JOY_HAT_CONST(DOWN);
-    /* Left position. */
+    /* @return [Integer] hat state\: Left position. */
     DEFINE_JOY_HAT_CONST(LEFT);
-    /* Right Up position. Equal to ({RIGHT} | {UP}) */
+    /* @return [Integer] hat state\: Right Up position. Equal to ({RIGHT} | {UP}) */
     DEFINE_JOY_HAT_CONST(RIGHTUP);
-    /* Right Down position. Equal to ({RIGHT} | {DOWN}) */
+    /* @return [Integer] hat state\: Right Down position. Equal to ({RIGHT} | {DOWN}) */
     DEFINE_JOY_HAT_CONST(RIGHTDOWN);
-    /* Left Up position. Equal to ({LEFT} | {UP}) */
+    /* @return [Integer] hat state\: Left Up position. Equal to ({LEFT} | {UP}) */
     DEFINE_JOY_HAT_CONST(LEFTUP);
-    /* Left Down position. Equal to ({LEFT} | {DOWN}) */
+    /* @return [Integer] hat state\: Left Down position. Equal to ({LEFT} | {DOWN}) */
     DEFINE_JOY_HAT_CONST(LEFTDOWN);
 
     /* Device GUID