ruby-sdl2 0.3.4 → 0.3.6

data/mixer.c

@@ -135,7 +135,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 +193,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 +456,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 +475,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 +540,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 +580,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 +754,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 +827,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 +837,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 +847,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 +970,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 +1077,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 +1164,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);

data/mixer.c.m4

@@ -135,7 +135,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 +193,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 +456,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 +475,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 +540,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 +580,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 +754,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 +827,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 +837,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 +847,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 +970,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 +1077,58 @@ void rubysdl2_init_mixer(void)
     rb_define_module_function(mMixer, "query", Mixer_s_query, 0);
     
     /* define(`DEFINE_MIX_INIT',`rb_define_const(mMixer, "INIT_$1", UINT2NUM(MIX_INIT_$1))') */
-    /* Initialize Ogg flac loader */
+    /* @return [Integer] bitmask which means initialization of Ogg flac loader */
     DEFINE_MIX_INIT(FLAC);
-    /* Initialize MOD loader */
+    /* @return [Integer] bitmask which means initialization of MOD loader */
     DEFINE_MIX_INIT(MOD);
-    /* Initialize MP3 loader */
+    /* @return [Integer] bitmask which means initialization of MP3 loader */
     DEFINE_MIX_INIT(MP3);
-    /* Initialize Ogg vorbis loader */
+    /* @return [Integer] bitmask which means initialization of Ogg vorbis loader */
     DEFINE_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 */
     DEFINE_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 */
     DEFINE_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 */
     DEFINE_MIX_INIT(MID);
 #endif
 
     /* define(`DEFINE_MIX_FORMAT',`rb_define_const(mMixer, "FORMAT_$1", UINT2NUM(AUDIO_$1))') */
-    /* Unsiged 8-bit sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Unsiged 8-bit sample format. Used by {Mixer.open} */
     DEFINE_MIX_FORMAT(U8);
-    /* Siged 8-bit sample format. Used by {Mixer.open} */
+    /* @return [Integer] the value representing Siged 8-bit sample format. Used by {Mixer.open} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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} */
     DEFINE_MIX_FORMAT(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 +1164,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);

data/mouse.c

@@ -192,7 +192,7 @@ static VALUE Cursor_s_shown_p(VALUE self)
  * @overload warp(window, x, y) 
  *   Move the mouse cursor to the given position within the window.
  *
- *   @param [SDL::Window] window the window to move the mouse cursor into
+ *   @param [SDL2::Window] window the window to move the mouse cursor into
  *   @param [Integer] x the x coordinate within the window
  *   @param [Integer] y the y coordinate within the window
  *   @return [nil]
@@ -225,7 +225,7 @@ static VALUE Cursor_s_warp_globally(VALUE self, VALUE x, VALUE y)
  *   Return true a mouse button is pressed.
  *
  *   @param [Integer] index the index of a mouse button, start at index 0
- * 
+ *   @return [Boolean]
  */
 static VALUE State_pressed_p(VALUE self, VALUE index)
 {
@@ -273,7 +273,7 @@ void rubysdl2_init_mouse(void)
     rb_define_singleton_method(cCursor, "shown?", Cursor_s_shown_p, 0);
     rb_define_singleton_method(cCursor, "warp", Cursor_s_warp, 3);
 #if SDL_VERSION_ATLEAST(2,0,4)
-    rb_define_singleton_method(cCursor, "warp_globally", Cursor_s_warp_globally, 3);
+    rb_define_singleton_method(cCursor, "warp_globally", Cursor_s_warp_globally, 2);
 #endif
     
     

data/rbs_collection.yaml

@@ -0,0 +1,32 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  # Skip loading rbs gem's RBS.
+  # It's unnecessary if you don't use rbs as a library.
+  - name: rbs
+    ignore: true
+  - name: yard
+    ignore: true
+  - name: rake
+    ignore: true
+  - name: sord
+    ignore: true
+  - name: ast
+    ignore: true
+  - name: rainbow
+    ignore: true
+  - name: steep
+    ignore: true

data/ttf.c

@@ -76,7 +76,7 @@ DEFINE_WRAPPER(TTF_Font, TTF, font, cTTF, "SDL2::TTF");
  *   
  * @!attribute kerning
  *   True if kerning is enabled.
- *   @return [Booelan]
+ *   @return [boolean]
  *   
  * @!attribute [r] height
  *   The maximum pixel height of all glyphs of the font.
@@ -193,7 +193,7 @@ TTF_ATTR_READER(face_style_name, FaceStyleName, utf8str_new_cstr);
  *
  *   @param text [String] the string to size up
  *   
- * @return [[Integer, Integer]] a pair of width and height of the rendered surface
+ * @return [Array(Integer, Integer)] a pair of width and height of the rendered surface
  *
  * @raise [SDL2::Error] It is raised when an error occurs, such as a glyph ins the
  *   string not being found.
@@ -237,7 +237,7 @@ static VALUE render(SDL_Surface* (*renderer)(TTF_Font*, const char*, SDL_Color,
  *   Solid mode rendering is quick but dirty.
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -258,9 +258,9 @@ static VALUE TTF_render_solid(VALUE self, VALUE text, VALUE fg)
  *   the background color.
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
- *   @param bg [[Integer, Integer, Integer]]
+ *   @param bg [Array(Integer, Integer, Integer)]
  *     the background color. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -281,7 +281,7 @@ static VALUE TTF_render_shaded(VALUE self, VALUE text, VALUE fg, VALUE bg)
  *   The rendered surface has an alpha channel, 
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -344,26 +344,26 @@ void rubysdl2_init_ttf(void)
 
     mStyle = rb_define_module_under(cTTF, "Style");
     /*  */
-    /* normal style */
+    /* @return [Integer] integer representing normal style */
     rb_define_const(mStyle, "NORMAL", INT2NUM((TTF_STYLE_NORMAL)));
-    /* bold style */
+    /* @return [Integer] integer representing bold style */
     rb_define_const(mStyle, "BOLD", INT2NUM((TTF_STYLE_BOLD)));
-    /* italic style */
+    /* @return [Integer] integer representing italic style */
     rb_define_const(mStyle, "ITALIC", INT2NUM((TTF_STYLE_ITALIC)));
-    /* underline style */
+    /* @return [Integer] integer representing underline style */
     rb_define_const(mStyle, "UNDERLINE", INT2NUM((TTF_STYLE_UNDERLINE)));
-    /* strikethrough style */
+    /* @return [Integer] integer representing strikethrough style */
     rb_define_const(mStyle, "STRIKETHROUGH", INT2NUM((TTF_STYLE_STRIKETHROUGH)));
 
     mHinting = rb_define_module_under(cTTF, "Hinting");
     /*  */
-    /* normal hinting, default */
+    /* @return [Integer] integer representing normal hinting, default */
     rb_define_const(mHinting, "NORMAL", INT2NUM((TTF_HINTING_NORMAL)));
-    /*  lighter hinting for non-monochrome modes */
+    /*  @return [Integer] integer representing lighter hinting for non-monochrome modes */
     rb_define_const(mHinting, "LIGHT", INT2NUM((TTF_HINTING_LIGHT)));
-    /* strong hinting only used for monochrome output */
+    /* @return [Integer] integer representing strong hinting, only used for monochrome output */
     rb_define_const(mHinting, "MONO", INT2NUM((TTF_HINTING_MONO)));
-    /* no hinting */
+    /* @return [Integer] integer representing no hinting */
     rb_define_const(mHinting, "NONE", INT2NUM((TTF_HINTING_NONE)));
 }
 

data/ttf.c.m4

@@ -76,7 +76,7 @@ DEFINE_WRAPPER(TTF_Font, TTF, font, cTTF, "SDL2::TTF");
  *   
  * @!attribute kerning
  *   True if kerning is enabled.
- *   @return [Booelan]
+ *   @return [boolean]
  *   
  * @!attribute [r] height
  *   The maximum pixel height of all glyphs of the font.
@@ -193,7 +193,7 @@ TTF_ATTR_READER(face_style_name, FaceStyleName, utf8str_new_cstr);
  *
  *   @param text [String] the string to size up
  *   
- * @return [[Integer, Integer]] a pair of width and height of the rendered surface
+ * @return [Array(Integer, Integer)] a pair of width and height of the rendered surface
  *
  * @raise [SDL2::Error] It is raised when an error occurs, such as a glyph ins the
  *   string not being found.
@@ -237,7 +237,7 @@ static VALUE render(SDL_Surface* (*renderer)(TTF_Font*, const char*, SDL_Color,
  *   Solid mode rendering is quick but dirty.
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -258,9 +258,9 @@ static VALUE TTF_render_solid(VALUE self, VALUE text, VALUE fg)
  *   the background color.
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
- *   @param bg [[Integer, Integer, Integer]]
+ *   @param bg [Array(Integer, Integer, Integer)]
  *     the background color. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -281,7 +281,7 @@ static VALUE TTF_render_shaded(VALUE self, VALUE text, VALUE fg, VALUE bg)
  *   The rendered surface has an alpha channel, 
  *   
  *   @param text [String] the text to render
- *   @param fg [[Integer, Integer, Integer]]
+ *   @param fg [Array(Integer, Integer, Integer)]
  *     the color to render. An array of r, g, and b components.
  *     
  * @return [SDL2::Surface]
@@ -344,26 +344,26 @@ void rubysdl2_init_ttf(void)
 
     mStyle = rb_define_module_under(cTTF, "Style");
     /* define(`DEFINE_TTF_STYLE_CONST',`rb_define_const(mStyle, "$1", INT2NUM((TTF_STYLE_$1)))') */
-    /* normal style */
+    /* @return [Integer] integer representing normal style */
     DEFINE_TTF_STYLE_CONST(NORMAL);
-    /* bold style */
+    /* @return [Integer] integer representing bold style */
     DEFINE_TTF_STYLE_CONST(BOLD);
-    /* italic style */
+    /* @return [Integer] integer representing italic style */
     DEFINE_TTF_STYLE_CONST(ITALIC);
-    /* underline style */
+    /* @return [Integer] integer representing underline style */
     DEFINE_TTF_STYLE_CONST(UNDERLINE);
-    /* strikethrough style */
+    /* @return [Integer] integer representing strikethrough style */
     DEFINE_TTF_STYLE_CONST(STRIKETHROUGH);
 
     mHinting = rb_define_module_under(cTTF, "Hinting");
     /* define(`DEFINE_TTF_HINTING_CONST',`rb_define_const(mHinting, "$1", INT2NUM((TTF_HINTING_$1)))') */
-    /* normal hinting, default */
+    /* @return [Integer] integer representing normal hinting, default */
     DEFINE_TTF_HINTING_CONST(NORMAL);
-    /*  lighter hinting for non-monochrome modes */
+    /*  @return [Integer] integer representing lighter hinting for non-monochrome modes */
     DEFINE_TTF_HINTING_CONST(LIGHT);
-    /* strong hinting only used for monochrome output */
+    /* @return [Integer] integer representing strong hinting, only used for monochrome output */
     DEFINE_TTF_HINTING_CONST(MONO);
-    /* no hinting */
+    /* @return [Integer] integer representing no hinting */
     DEFINE_TTF_HINTING_CONST(NONE);
 }