ruby-sdl2 0.3.5 → 0.3.7

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.7"
+  # @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));
 

data/mixer.c

@@ -27,34 +27,40 @@ typedef struct Music {
 
 static void Chunk_free(Chunk* c)
 {
-    if (rubysdl2_is_active() && c->chunk) 
+    if (rubysdl2_is_active() && c->chunk)
         Mix_FreeChunk(c->chunk);
     free(c);
 }
 
+DEFINE_DATA_TYPE(Chunk, Chunk_free);
+
 static VALUE Chunk_new(Mix_Chunk* chunk)
 {
-    Chunk* c = ALLOC(Chunk);
+    Chunk* c;
+    VALUE obj = TypedData_Make_Struct(cChunk, Chunk, &Chunk_data_type, c);
     c->chunk = chunk;
-    return Data_Wrap_Struct(cChunk, 0, Chunk_free, c);
+    return obj;
 }
 
 DEFINE_WRAPPER(Mix_Chunk, Chunk, chunk, cChunk, "SDL2::Mixer::Chunk");
 
 static void Music_free(Music* m)
 {
-    if (rubysdl2_is_active() && m->music) 
+    if (rubysdl2_is_active() && m->music)
         Mix_FreeMusic(m->music);
     free(m);
 }
 
+DEFINE_DATA_TYPE(Music, Music_free);
+
 static VALUE Music_new(Mix_Music* music)
 {
-    Music* c = ALLOC(Music);
+    Music* c;
+    VALUE obj = TypedData_Make_Struct(cMusic, Music, &Music_data_type, c);
     c->music = music;
-    return Data_Wrap_Struct(cMusic, 0, Music_free, c);
+    return obj;
 }
-                            
+
 DEFINE_WRAPPER(Mix_Music, Music, music, cMusic, "SDL2::Mixer::Music");
 
 /*
@@ -135,7 +141,7 @@ static void check_channel(VALUE ch, int allow_minus_1)
     int channel = NUM2INT(ch);
     if (channel >= Mix_AllocateChannels(-1))
         rb_raise(rb_eArgError, "too large number of channel (%d)", channel);
-    if (channel == -1 && !allow_minus_1 || channel < -1)
+    if ((channel == -1 && !allow_minus_1) || channel < -1)
         rb_raise(rb_eArgError, "negative number of channel is not allowed");
 }
 
@@ -193,7 +199,7 @@ static VALUE Mixer_s_close(VALUE self)
  *
  * This method returns the most suitable setting for {.open} the device.
  *
- * @return [[Integer, Integer, Integer, Integer]]
+ * @return [Array(Integer, Integer, Integer, Integer)]
  *   the suitable frequency in Hz, the suitable format,
  *   the suitable number of channels (1 for mono, 2 for stereo),
  *   and the number of call of {.open}.
@@ -456,6 +462,8 @@ static VALUE Channels_s_fade_out(VALUE self, VALUE channel, VALUE ms)
  *   Return true if a specified channel is playing.
  *   
  *   @param channel [Integer] channel to test
+ *   @return [Boolean]
+ *
  *   @see .pause?
  *   @see .fading
  */
@@ -473,6 +481,7 @@ static VALUE Channels_s_play_p(VALUE self, VALUE channel)
  *     other halting methods.
  *   
  *   @param channel [Integer] channel to test
+ *   @return [Boolean]
  *
  *   @see .play?
  *   @see .fading
@@ -537,6 +546,8 @@ static VALUE Channels_s_playing_chunk(VALUE self, VALUE channel)
 /*
  * Initialize the channel with given **tag**.
  *
+ * @param tag [Integer] channel indentifier
+ * 
  * Groups with a common tag are identified.
  */
 static VALUE Group_initialize(VALUE self, VALUE tag)
@@ -575,7 +586,7 @@ inline static int Group_tag(VALUE group)
  *   **self** and **other** are considered to be same
  *   if they have the same tag.
  *   
- *   @param other [SDL2::Mixer::Channel::Group] a compared object
+ *   @param other [SDL2::Mixer::Channels::Group] a compared object
  *   @return [Boolean]
  */
 static VALUE Group_eq(VALUE self, VALUE other)
@@ -749,7 +760,7 @@ static VALUE MusicChannel_s_volume(VALUE self)
  *
  *   @param vol [Integer] the volume for mixing,
  *     from 0 to {SDL2::Mixer::MAX_VOLUME}(128).
- *   @return [vol]
+ *   @return [void]
  *   
  *   @see .volume
  */
@@ -822,6 +833,7 @@ static VALUE MusicChannel_s_halt(VALUE self)
  * @overload fade_out(ms)
  *   Halt the music playback with fade-out effect.
  *
+ *   @param ms [Integer] milliseconds of fade-out effect
  *   @return [nil]
  */
 static VALUE MusicChannel_s_fade_out(VALUE self, VALUE fade_out_ms)
@@ -831,6 +843,8 @@ static VALUE MusicChannel_s_fade_out(VALUE self, VALUE fade_out_ms)
 
 /*
  * Return true if a music is playing.
+ *
+ * @return [Boolean]
  */
 static VALUE MusicChannel_s_play_p(VALUE self)
 {
@@ -839,6 +853,8 @@ static VALUE MusicChannel_s_play_p(VALUE self)
 
 /*
  * Return true if a music playback is paused.
+ *
+ * @return [Boolean]
  */
 static VALUE MusicChannel_s_pause_p(VALUE self)
 {
@@ -960,7 +976,7 @@ static VALUE Chunk_volume(VALUE self)
  *   Set the volume of the sample.
  *
  *   @param vol [Integer] the new volume
- *   @return [vol]
+ *   @return [void]
  *
  *   @see #volume
  */
@@ -1067,58 +1083,58 @@ void rubysdl2_init_mixer(void)
     rb_define_module_function(mMixer, "query", Mixer_s_query, 0);
     
     /*  */
-    /* Initialize Ogg flac loader */
+    /* @return [Integer] bitmask which means initialization of Ogg flac loader */
     rb_define_const(mMixer, "INIT_FLAC", UINT2NUM(MIX_INIT_FLAC));
-    /* Initialize MOD loader */
+    /* @return [Integer] bitmask which means initialization of MOD loader */
     rb_define_const(mMixer, "INIT_MOD", UINT2NUM(MIX_INIT_MOD));
-    /* Initialize MP3 loader */
+    /* @return [Integer] bitmask which means initialization of MP3 loader */
     rb_define_const(mMixer, "INIT_MP3", UINT2NUM(MIX_INIT_MP3));
-    /* Initialize Ogg vorbis loader */
+    /* @return [Integer] bitmask which means initialization of Ogg vorbis loader */
     rb_define_const(mMixer, "INIT_OGG", UINT2NUM(MIX_INIT_OGG));
 
-#if HAVE_CONST_MIX_INIT_MODPLUG
-    /* Initialize libmodplug */
+#ifdef HAVE_CONST_MIX_INIT_MODPLUG
+    /* @return [Integer] bitmask which means initialization of libmodplug */
     rb_define_const(mMixer, "INIT_MODPLUG", UINT2NUM(MIX_INIT_MODPLUG));
 #endif
-#if HAVE_CONST_MIX_INIT_FLUIDSYNTH
-    /* Initialize fluidsynth */
+#ifdef HAVE_CONST_MIX_INIT_FLUIDSYNTH
+    /* @return [Integer] bitmask which means initialization of fluidsynth */
     rb_define_const(mMixer, "INIT_FLUIDSYNTH", UINT2NUM(MIX_INIT_FLUIDSYNTH));
 #endif
-#if HAVE_CONST_MIX_INIT_MID
-    /* Initialize mid */
+#ifdef HAVE_CONST_MIX_INIT_MID
+    /* @return [Integer] bitmask which means initialization of mid */
     rb_define_const(mMixer, "INIT_MID", UINT2NUM(MIX_INIT_MID));
 #endif
 
     /*  */
-    /* Unsiged 8-bit sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 8-bit sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_U8", UINT2NUM(AUDIO_U8));
-    /* Siged 8-bit sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Siged 8-bit sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_S8", UINT2NUM(AUDIO_S8));
-    /* Unsiged 16-bit little-endian sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 16-bit little-endian sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_U16LSB", UINT2NUM(AUDIO_U16LSB));
-    /* Siged 16-bit little-endian sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Siged 16-bit little-endian sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_S16LSB", UINT2NUM(AUDIO_S16LSB));
-    /* Unsiged 16-bit big-endian sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 16-bit big-endian sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_U16MSB", UINT2NUM(AUDIO_U16MSB));
-    /* Unsiged 16-bit big-endian sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 16-bit big-endian sample format. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_S16MSB", UINT2NUM(AUDIO_S16MSB));
-    /* Unsiged 16-bit sample format. Endian is same as system byte order. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 16-bit sample format. Endian is same as system byte order. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_U16SYS", UINT2NUM(AUDIO_U16SYS));
-    /* Siged 16-bit sample format. Endian is same as system byte order. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Siged 16-bit sample format. Endian is same as system byte order. Used by {Mixer.open} */
     rb_define_const(mMixer, "FORMAT_S16SYS", UINT2NUM(AUDIO_S16SYS));
-    /* Default frequency. 22050 (Hz) */
+    /* @return [Integer] Default frequency. 22050 (Hz) */
     rb_define_const(mMixer, "DEFAULT_FREQUENCY", UINT2NUM(MIX_DEFAULT_FREQUENCY));
-    /* Default sample format. Same as {Mixer::FORMAT_S16SYS}. */
+    /* @return [Integer] Default sample format. Same as {Mixer\:\:FORMAT_S16SYS}. */
     rb_define_const(mMixer, "DEFAULT_FORMAT", UINT2NUM(MIX_DEFAULT_FORMAT));
-    /* Default number of channels. 2. */
+    /* @return [Integer] Default number of channels. 2. */
     rb_define_const(mMixer, "DEFAULT_CHANNELS", INT2FIX(MIX_DEFAULT_CHANNELS));
-    /* Max volume value. 128. */
+    /* @return [Integer] Max volume value. 128. */
     rb_define_const(mMixer, "MAX_VOLUME", INT2FIX(MIX_MAX_VOLUME));
-    /* This constants represents that the channel is not fading in and fading out. */
+    /* @return [Integer] the value represents that the channel is not fading in and fading out. */
     rb_define_const(mMixer, "NO_FADING", INT2FIX(MIX_NO_FADING));
-    /* This constants represents that the channel is fading out. */
+    /* @return [Integer] the value represents that the channel is fading out. */
     rb_define_const(mMixer, "FADING_OUT", INT2FIX(MIX_FADING_OUT));
-    /* This constants represents that the channel is fading in. */
+    /* @return [Integer] the value represents that the channel is fading in. */
     rb_define_const(mMixer, "FADING_IN", INT2FIX(MIX_FADING_IN));
 
     
@@ -1154,7 +1170,7 @@ void rubysdl2_init_mixer(void)
     rb_define_module_function(mChannels, "pause", Channels_s_pause, 1);
     rb_define_module_function(mChannels, "resume", Channels_s_resume, 1);
     rb_define_module_function(mChannels, "halt", Channels_s_halt, 1);
-    rb_define_module_function(mChannels, "expire", Channels_s_expire, 1);
+    rb_define_module_function(mChannels, "expire", Channels_s_expire, 2);
     rb_define_module_function(mChannels, "fade_out", Channels_s_fade_out, 2);
     rb_define_module_function(mChannels, "play?", Channels_s_play_p, 1);
     rb_define_module_function(mChannels, "pause?", Channels_s_pause_p, 1);