ruby-sdl2 0.3.5 → 0.3.6

data/gl.c.m4

@@ -115,8 +115,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 +129,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 +190,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 +217,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 +274,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 +284,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

@@ -99,6 +99,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 +226,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 +310,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

@@ -99,6 +99,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 +226,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 +310,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

data/key.c

@@ -65,6 +65,8 @@ static VALUE Key_s_keycode_from_scancode(VALUE self, VALUE scancode)
  * @overload pressed?(code)
  *   @param [Integer] code scancode
  *
+ * @return [Boolean] true if pressed
+ *
  * Get whether the key of the given scancode is pressed or not.
  */
 static VALUE Key_s_pressed_p(VALUE self, VALUE code)
@@ -159,7 +161,7 @@ static VALUE Mod_s_state(VALUE self)
  * Set the current key modifier state
  * 
  * @note This does not change the keyboard state, only the key modifier flags.
- * @return [keymod]
+ * @return [void]
  * @see .state
  */
 static VALUE Mod_s_set_state(VALUE self, VALUE keymod)
@@ -220,7 +222,7 @@ static VALUE TextInput_s_stop(VALUE self)
  *   Set the rectanlgle used to type Unicode text inputs.
  *
  *   @param rect [SDL2::Rect] the rectangle to receive text
- *   @return [rect]
+ *   @return [void]
  */
 static VALUE TextInput_s_set_rect(VALUE self, VALUE rect)
 {
@@ -1265,38 +1267,38 @@ void rubysdl2_init_key(void)
     /* @return [Integer] keycode for "SLEEP" key */
     rb_define_const(mKey, "SLEEP", INT2NUM(SDLK_SLEEP));
 
-    /* 0 (no modifier is applicable) */
+    /* @return [Integer] 0 (no modifier is applicable) */
     rb_define_const(mMod, "NONE", INT2NUM(KMOD_NONE));
-    /* the modifier key bit mask for the left shift key */
+    /* @return [Integer] the modifier key bit mask for the left shift key */
     rb_define_const(mMod, "LSHIFT", INT2NUM(KMOD_LSHIFT));
-    /* the modifier key bit mask for the right shift key */
+    /* @return [Integer] the modifier key bit mask for the right shift key */
     rb_define_const(mMod, "RSHIFT", INT2NUM(KMOD_RSHIFT));
-    /* the modifier key bit mask for the left control key */
+    /* @return [Integer] the modifier key bit mask for the left control key */
     rb_define_const(mMod, "LCTRL", INT2NUM(KMOD_LCTRL));
-    /* the modifier key bit mask for the right control key */
+    /* @return [Integer] the modifier key bit mask for the right control key */
     rb_define_const(mMod, "RCTRL", INT2NUM(KMOD_RCTRL));
-    /* the modifier key bit mask for the left alt key */
+    /* @return [Integer] the modifier key bit mask for the left alt key */
     rb_define_const(mMod, "LALT", INT2NUM(KMOD_LALT));
-    /* the modifier key bit mask for the right alt key */
+    /* @return [Integer] the modifier key bit mask for the right alt key */
     rb_define_const(mMod, "RALT", INT2NUM(KMOD_RALT));
-    /* the modifier key bit mask for the left GUI key (often the window key) */
+    /* @return [Integer] the modifier key bit mask for the left GUI key (often the window key) */
     rb_define_const(mMod, "LGUI", INT2NUM(KMOD_LGUI));
-    /* the modifier key bit mask for the right GUI key (often the window key) */
+    /* @return [Integer] the modifier key bit mask for the right GUI key (often the window key) */
     rb_define_const(mMod, "RGUI", INT2NUM(KMOD_RGUI));
-    /* the modifier key bit mask for the numlock key */
+    /* @return [Integer] the modifier key bit mask for the numlock key */
     rb_define_const(mMod, "NUM", INT2NUM(KMOD_NUM));
-    /* the modifier key bit mask for the capslock key */
+    /* @return [Integer] the modifier key bit mask for the capslock key */
     rb_define_const(mMod, "CAPS", INT2NUM(KMOD_CAPS));
-    /* the modifier key bit mask for the mode key (AltGr) */
+    /* @return [Integer] the modifier key bit mask for the mode key (AltGr) */
     rb_define_const(mMod, "MODE", INT2NUM(KMOD_MODE));
-    /* the modifier key bit mask for the left and right control key */
+    /* @return [Integer] the modifier key bit mask for the left and right control key */
     rb_define_const(mMod, "CTRL", INT2NUM(KMOD_CTRL));
-    /* the modifier key bit mask for the left and right shift key */
+    /* @return [Integer] the modifier key bit mask for the left and right shift key */
     rb_define_const(mMod, "SHIFT", INT2NUM(KMOD_SHIFT));
-    /* the modifier key bit mask for the left and right alt key */
+    /* @return [Integer] the modifier key bit mask for the left and right alt key */
     rb_define_const(mMod, "ALT", INT2NUM(KMOD_ALT));
-    /* the modifier key bit mask for the left and right GUI key */
+    /* @return [Integer] the modifier key bit mask for the left and right GUI key */
     rb_define_const(mMod, "GUI", INT2NUM(KMOD_GUI));
-    /* reserved for future use */
+    /* @return [Integer] reserved bit mask for future use */
     rb_define_const(mMod, "RESERVED", INT2NUM(KMOD_RESERVED));
 }

data/key.c.m4

@@ -65,6 +65,8 @@ static VALUE Key_s_keycode_from_scancode(VALUE self, VALUE scancode)
  * @overload pressed?(code)
  *   @param [Integer] code scancode
  *
+ * @return [Boolean] true if pressed
+ *
  * Get whether the key of the given scancode is pressed or not.
  */
 static VALUE Key_s_pressed_p(VALUE self, VALUE code)
@@ -159,7 +161,7 @@ static VALUE Mod_s_state(VALUE self)
  * Set the current key modifier state
  * 
  * @note This does not change the keyboard state, only the key modifier flags.
- * @return [keymod]
+ * @return [void]
  * @see .state
  */
 static VALUE Mod_s_set_state(VALUE self, VALUE keymod)
@@ -220,7 +222,7 @@ static VALUE TextInput_s_stop(VALUE self)
  *   Set the rectanlgle used to type Unicode text inputs.
  *
  *   @param rect [SDL2::Rect] the rectangle to receive text
- *   @return [rect]
+ *   @return [void]
  */
 static VALUE TextInput_s_set_rect(VALUE self, VALUE rect)
 {
@@ -796,38 +798,38 @@ void rubysdl2_init_key(void)
     DEFINE_KEYCODE(EJECT);
     DEFINE_KEYCODE(SLEEP);
 
-    /* 0 (no modifier is applicable) */
+    /* @return [Integer] 0 (no modifier is applicable) */
     DEFINE_KEYMOD(NONE);
-    /* the modifier key bit mask for the left shift key */
+    /* @return [Integer] the modifier key bit mask for the left shift key */
     DEFINE_KEYMOD(LSHIFT);
-    /* the modifier key bit mask for the right shift key */
+    /* @return [Integer] the modifier key bit mask for the right shift key */
     DEFINE_KEYMOD(RSHIFT);
-    /* the modifier key bit mask for the left control key */
+    /* @return [Integer] the modifier key bit mask for the left control key */
     DEFINE_KEYMOD(LCTRL);
-    /* the modifier key bit mask for the right control key */
+    /* @return [Integer] the modifier key bit mask for the right control key */
     DEFINE_KEYMOD(RCTRL);
-    /* the modifier key bit mask for the left alt key */
+    /* @return [Integer] the modifier key bit mask for the left alt key */
     DEFINE_KEYMOD(LALT);
-    /* the modifier key bit mask for the right alt key */
+    /* @return [Integer] the modifier key bit mask for the right alt key */
     DEFINE_KEYMOD(RALT);
-    /* the modifier key bit mask for the left GUI key (often the window key) */
+    /* @return [Integer] the modifier key bit mask for the left GUI key (often the window key) */
     DEFINE_KEYMOD(LGUI);
-    /* the modifier key bit mask for the right GUI key (often the window key) */
+    /* @return [Integer] the modifier key bit mask for the right GUI key (often the window key) */
     DEFINE_KEYMOD(RGUI);
-    /* the modifier key bit mask for the numlock key */
+    /* @return [Integer] the modifier key bit mask for the numlock key */
     DEFINE_KEYMOD(NUM);
-    /* the modifier key bit mask for the capslock key */
+    /* @return [Integer] the modifier key bit mask for the capslock key */
     DEFINE_KEYMOD(CAPS);
-    /* the modifier key bit mask for the mode key (AltGr) */
+    /* @return [Integer] the modifier key bit mask for the mode key (AltGr) */
     DEFINE_KEYMOD(MODE);
-    /* the modifier key bit mask for the left and right control key */
+    /* @return [Integer] the modifier key bit mask for the left and right control key */
     DEFINE_KEYMOD(CTRL);
-    /* the modifier key bit mask for the left and right shift key */
+    /* @return [Integer] the modifier key bit mask for the left and right shift key */
     DEFINE_KEYMOD(SHIFT);
-    /* the modifier key bit mask for the left and right alt key */
+    /* @return [Integer] the modifier key bit mask for the left and right alt key */
     DEFINE_KEYMOD(ALT);
-    /* the modifier key bit mask for the left and right GUI key */
+    /* @return [Integer] the modifier key bit mask for the left and right GUI key */
     DEFINE_KEYMOD(GUI);
-    /* reserved for future use */
+    /* @return [Integer] reserved bit mask for future use */
     DEFINE_KEYMOD(RESERVED);
 }

data/lib/sdl2/version.rb

@@ -1,6 +1,6 @@
 module SDL2
-  # Version string of Ruby/SDL2
-  VERSION = "0.3.5"
-  # Version of Ruby/SDL2, [major, minor, patch level] 
+  # @return [String] Version string of Ruby/SDL2
+  VERSION = "0.3.6"
+  # @return [Array<Integer>] Version of Ruby/SDL2, [major, minor, patch level] 
   VERSION_NUMBER = VERSION.split(".").map(&:to_i)
 end

data/main.c

@@ -145,11 +145,6 @@ static VALUE libsdl_revision(void)
     return rb_usascii_str_new_cstr(SDL_GetRevision());
 }
 
-static VALUE libsdl_revision_number(void)
-{
-    return INT2NUM(SDL_GetRevisionNumber());
-}
-
 /*
  * Document-module: SDL2
  *
@@ -183,39 +178,41 @@ void Init_sdl2_ext(void)
     DEFINE_SDL_INIT_CONST(EVERYTHING);
     DEFINE_SDL_INIT_CONST(NOPARACHUTE);
 
-    /* SDL's version string  */
+    /* @return [String] SDL's version string  */
     rb_define_const(mSDL2, "LIBSDL_VERSION", libsdl_version());
-    /* SDL's version array of numbers  */
+    /* @return [Array(Integer, Integer, Integer)] SDL's version array of numbers  */
     rb_define_const(mSDL2, "LIBSDL_VERSION_NUMBER", libsdl_version_number());
-    /* SDL's revision (from VCS) string  */
+    /* @return [String] SDL's revision (from VCS) string  */
     rb_define_const(mSDL2, "LIBSDL_REVISION", libsdl_revision());
-    /* SDL's revision (from VCS) array of numbers  */
-    rb_define_const(mSDL2, "LIBSDL_REVISION_NUMBER", libsdl_revision_number());
+    /* @return [Integer] always 0
+     * @deprecated
+     */
+    rb_define_const(mSDL2, "LIBSDL_REVISION_NUMBER", INT2NUM(0));
 
 #ifdef HAVE_SDL_IMAGE_H
     {
         const SDL_version* version = IMG_Linked_Version();
-        /* SDL_image's version string, only available if SDL_image is linked */
+        /* @return [String] SDL_image's version string, only available if SDL_image is linked */
         rb_define_const(mSDL2, "LIBSDL_IMAGE_VERSION", SDL_version_to_String(version));
-        /* SDL_image's version array of numbers */
+        /* @return [Array(Integer, Integer, Integer)] SDL_image's version array of numbers */
         rb_define_const(mSDL2, "LIBSDL_IMAGE_VERSION_NUMBER", SDL_version_to_Array(version));
     }
 #endif
 #ifdef HAVE_SDL_TTF_H
     {
         const SDL_version* version = TTF_Linked_Version();
-        /* SDL_ttf's version string, only available if SDL_ttf is linked */
+        /* @return [String] SDL_ttf's version string, only available if SDL_ttf is linked */
         rb_define_const(mSDL2, "LIBSDL_TTF_VERSION", SDL_version_to_String(version));
-        /* SDL_ttf's version array of numbers */
+        /* @return [Array(Integer, Integer, Integer)] SDL_ttf's version array of numbers */
         rb_define_const(mSDL2, "LIBSDL_TTF_VERSION_NUMBER", SDL_version_to_Array(version));
     }
 #endif
 #ifdef HAVE_SDL_MIXER_H
     {
         const SDL_version* version = Mix_Linked_Version();
-        /* SDL_mixer's version string , only available if SDL_mixer is linked */
+        /* @return [Integer] SDL_mixer's version string , only available if SDL_mixer is linked */
         rb_define_const(mSDL2, "LIBSDL_MIXER_VERSION", SDL_version_to_String(version));
-        /* SDL_mixer's version array of numbers */
+        /* @return [Array(Integer, Integer, Integer)] SDL_mixer's version array of numbers */
         rb_define_const(mSDL2, "LIBSDL_MIXER_VERSION_NUMBER", SDL_version_to_Array(version));
     }
 #endif

data/messagebox.c

@@ -70,7 +70,7 @@ static void set_color_scheme(VALUE colors, VALUE sym, SDL_MessageBoxColor* color
 }
 
 /*
- * @overload show(flag:, window: nil, title:, message:, buttons:, color_scheme: nil)
+ * @overload show(flags:, window: nil, title:, message:, buttons:, color_scheme: nil)
  *   Create a model message box.
  *
  *   You specify one of the following constants as flag
@@ -134,7 +134,7 @@ static void set_color_scheme(VALUE colors, VALUE sym, SDL_MessageBoxColor* color
  *   @param [String] title the title text
  *   @param [String] message the message text
  *   @param [Array<Hash<Symbol => Object>>] buttons array of buttons
- *   @param [Hash<Symbol=>[Integer,Integer,Integer]> nil] color_scheme
+ *   @param [Hash<Symbol=>Array(Integer,Integer,Integer)>, nil] color_scheme
  *       color scheme, or nil for the default color scheme
  *   @return [Integer] pressed button id
  *   
@@ -205,16 +205,16 @@ void rubysdl2_init_messagebox(void)
     rb_define_singleton_method(mMessageBox, "show_simple_box",
                                MessageBox_s_show_simple_box, 4);
     rb_define_singleton_method(mMessageBox, "show", MessageBox_s_show, 1);
-    /* This flag means that the message box shows an error message */
+    /* @return [Integer] the flag whcih means that the message box shows an error message */
     rb_define_const(mMessageBox, "ERROR", INT2NUM(SDL_MESSAGEBOX_ERROR));
-    /* This flag means that the message box shows a warning message */
+    /* @return [Integer] the flag whcih means that the message box shows a warning message */
     rb_define_const(mMessageBox, "WARNING", INT2NUM(SDL_MESSAGEBOX_WARNING));
-    /* This flag means that the message box shows an informational message */
+    /* @return [Integer] the flag whcih means that the message box shows an informational message */
     rb_define_const(mMessageBox, "INFORMATION", INT2NUM(SDL_MESSAGEBOX_INFORMATION));
-    /* This flag represents the button is selected when return key is pressed */
+    /* @return [Integer] the flag whcih represents the button is selected when return key is pressed */
     rb_define_const(mMessageBox, "BUTTON_RETURNKEY_DEFAULT",
                     INT2NUM(SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT));
-    /* This flag represents the button is selected when escape key is pressed */
+    /* @return [Integer] the flag whcih represents the button is selected when escape key is pressed */
     rb_define_const(mMessageBox, "BUTTON_ESCAPEKEY_DEFAULT",
                     INT2NUM(SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT));