ruby-sdl2 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 016174bf93fa2371562b5b7db39fad4ba4fe56ca33224bd426f124f71089c3f9
-  data.tar.gz: 4429f621dc957430f6532151481b4bfcaa10491bb5591a335d10b8f696e89769
+  metadata.gz: f0e0bde3276687797e754fb38566b3c23258a0cabedd2cb1b3b8c89fd20f03b1
+  data.tar.gz: 18ed3f916732eac3c54978dd251b4a01b86dfb71e33a8a4d105d906edeecf8dc
 SHA512:
-  metadata.gz: 1a2c0cb576204313adb1d8d1483d4f535366a4be0e2d33fc60c9bbe218197cae990031af9c0e7302fa8ff3051aa4e2f4b7664d9058313a0902d394c80dd4480a
-  data.tar.gz: 512fab96cd60f418159b7846b2891304458a88e4f58f5686683a3bfc00831834ae2a87d68683198d3716d60d00fe4b5bf1c689b9335d2e9b5139ed5475f91bc2
+  metadata.gz: c86c17d1f78f2a4d1835221a08490fc3c1cd5d4fb7848e9a926b7c6d89c3afcc758054f667c5242e2773dbe1a554bd92872bf23cc1f214fc58312527f79ffbda
+  data.tar.gz: e5314ba882de2a93c433b336590286482f9485092da806f711fbabda9e78ee0cb6781310e97f8f11270048bb3acfbcc261628c3bbadf1d17c8a38abb15c9b14c

data/.gitignore

@@ -11,6 +11,8 @@ mixer.c
 joystick.c
 gamecontroller.c
 extconf.h
+sdl2.rbi
+sdl2.rbs
 pkg/
 TAGS
 local/
@@ -20,4 +22,5 @@ sample/sample.wav
 .yardoc/
 doc/doc-*
 doc/po/rubysdl2.pot
-extconf-options.txt
+extconf-options.txt
+.gem_rbs_collection/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :development do
+  gem "rake"
+  gem "yard"
+  gem "sord", path: "../sord/main"  # For locally modified sord, PR is already sent.
+  gem "steep", "~> 1.3.0"  # sord depends on rbs 2.x, but steep 1.4.x depends rbs 3.x
+  gem "parallel", "~> 1.22.0"  #  parallel >= 1.23.0 breaks compatibility
+end

data/README.md

@@ -12,8 +12,11 @@ Before installing Ruby/SDL2, you need to install:
 * [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/)
 * [SDL_ttf](https://www.libsdl.org/projects/SDL_ttf/)
 
-After installing these libraries, you can install Ruby/SDL2
-from github:
+After installing these libraries, you can install Ruby/SDL2 by gem command as follows:
+
+    gem install ruby-sdl2
+    
+Alternatively You can also install the master version of Ruby/SDL2 from github:
 
     git clone https://github.com/ohai/ruby-sdl2.git
     cd ruby-sdl2

data/Rakefile

@@ -10,7 +10,9 @@ RB_FILES = Dir.glob("lib/**/*.rb")
 O_FILES = Rake::FileList[*C_FILES].pathmap('%n.o')
 
 POT_SOURCES = RB_FILES + ["main.c"] + (C_FILES - ["main.c"])
+YARD_DOC_FILES = ["README.md", "COPYING.txt"] + POT_SOURCES
 YARD_SOURCES = "-m markdown --main README.md --files COPYING.txt #{POT_SOURCES.join(" ")}"
+YARD_CHECKSUM_FILE = ".yardoc/checksums"
 
 WATCH_TARGETS = (C_FILES - C_FROM_M4_FILES) + C_M4_FILES + ["README.md"]
 
@@ -74,7 +76,7 @@ if locale
     sh "yard doc -o doc/doc-#{locale} --locale #{locale} --po-dir doc/po #{YARD_SOURCES}"
   end
 else
-  task "doc" => POT_SOURCES do
+  task "doc" => YARD_DOC_FILES do
     sh "yard doc -o doc/doc-en #{YARD_SOURCES}"
   end
 end
@@ -84,7 +86,7 @@ task "doc-all" do
 end
 
 desc "List undocumented classes/modules/methods/constants"
-task "doc-stat-undocumented" => POT_SOURCES do
+task "doc-stat-undocumented" => YARD_DOC_FILES do
   sh "yard stats --list-undoc --compact #{YARD_SOURCES}"
 end
 
@@ -110,3 +112,21 @@ task "watch-doc" do
     sh "inotifywait -e modify #{WATCH_TARGETS.join(" ")} && rake doc && notify-send -u low \"Ruby/SDL2 build doc OK\""
   end
 end
+
+file YARD_CHECKSUM_FILE => YARD_DOC_FILES do
+  sh "yard doc -n #{YARD_SOURCES}"
+end
+
+file "sdl2.rbs" => YARD_CHECKSUM_FILE do
+  sh "sord --no-regenerate --rbs sdl2.rbs"
+end
+
+file "sdl2.rbi" => YARD_CHECKSUM_FILE do
+  sh "sord --no-regenerate --rbi sdl2.rbi"
+end
+
+task "clean" do
+  sh "rm -r .yardoc"
+  sh "rm -r doc/doc-en"
+  sh "rm #{C_FROM_M4_FILES.join(' ')}"
+end

data/Steepfile

@@ -0,0 +1,24 @@
+D = Steep::Diagnostic
+
+# target :lib do
+#   signature "sdl2.rbs"
+#   library "rbs"
+
+#   check "lib"
+# end
+
+target :sample_testspriteminimal do
+  signature "sample/testspriteminimal.rbs"
+  signature "sdl2.rbs"
+  library "rbs"
+
+  check "sample/testspriteminimal.rb"
+  
+  
+  # configure_code_diagnostics(D::Ruby.strict)
+  # configure_code_diagnostics(D::Ruby.lenient)
+  configure_code_diagnostics do |hash|
+    hash[D::Ruby::MethodDefinitionMissing] = :information
+    hash[D::Ruby::UnknownConstant] = :information
+  end
+end

data/doc/DEVELOP.md

@@ -0,0 +1,35 @@
+# For Developer
+
+
+## Check out and build a gem
+
+    git clone https://github.com/ohai/ruby-sdl2.git
+    cd ruby-sdl2
+    bundle install
+    bundle exec rake gem  # To build a gem
+    bundle exec rake doc  # To build API documents
+    
+## Build C extension and run samples 
+
+    bundle exec rake build  # To build sdl2_ext.so
+    cd sample
+    ruby -I .. -I ../lib testspriteminimal.rb
+
+## For type checking
+
+Preparation
+
+    bundle exec rbs collection install
+    
+Generate ruby-sdl2's rbs file
+
+    bundle exec rake sdl2.rbs
+
+Signature file validation
+
+    bundle exec steep validate
+
+Type checking with Steep
+
+    bundle exec steep check
+

data/event.c

@@ -326,11 +326,11 @@ static VALUE EvWindow_inspect(VALUE self)
  *
  * @attribute pressed
  *   key is pressed
- *   @return [Integer]
+ *   @return [boolean]
  *
  * @attribute repeat
  *   key repeat
- *   @return [Integer]
+ *   @return [boolean]
  *   
  * @attribute scancode
  *   physical key code
@@ -690,7 +690,7 @@ static VALUE EvJoyButton_inspect(VALUE self)
 EVENT_ACCESSOR_INT(JoyAxisMotion, which, jaxis.which);
 EVENT_ACCESSOR_UINT8(JoyAxisMotion, axis, jaxis.axis);
 EVENT_ACCESSOR_INT(JoyAxisMotion, value, jaxis.value);
-/* @return [Stirng] inspection string */
+/* @return [String] inspection string */
 static VALUE EvJoyAxisMotion_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);

data/gamecontroller.c

@@ -302,6 +302,7 @@ static VALUE GameController_axis(VALUE self, VALUE axis)
  *   Return true if a button is pressed.
  *   
  *   @param button [Integer] the index of a button, one of the constants in {Button}
+ *   @return [Boolean]
  */
 static VALUE GameController_button_pressed_p(VALUE self, VALUE button)
 {
@@ -353,56 +354,56 @@ void rubysdl2_init_gamecontorller(void)
     mButton = rb_define_module_under(cGameController, "Button");
 
     /*  */
-    /* Invalid axis index */
+    /* @return [Integer] index for invalid axis*/
     rb_define_const(mAxis, "INVALID", INT2NUM(SDL_CONTROLLER_AXIS_INVALID));
-    /* Left X axis */
+    /* @return [Integer] index for Left X axis */
     rb_define_const(mAxis, "LEFTX", INT2NUM(SDL_CONTROLLER_AXIS_LEFTX));
-    /* Left Y axis */
+    /* @return [Integer] index for Left Y axis */
     rb_define_const(mAxis, "LEFTY", INT2NUM(SDL_CONTROLLER_AXIS_LEFTY));
-    /* Right X axis */
+    /* @return [Integer] index for Right X axis */
     rb_define_const(mAxis, "RIGHTX", INT2NUM(SDL_CONTROLLER_AXIS_RIGHTX));
-    /* Right Y axis */
+    /* @return [Integer] index for Right Y axis */
     rb_define_const(mAxis, "RIGHTY", INT2NUM(SDL_CONTROLLER_AXIS_RIGHTY));
-    /* Left trigger axis */
+    /* @return [Integer] index for Left trigger axis */
     rb_define_const(mAxis, "TRIGGERLEFT", INT2NUM(SDL_CONTROLLER_AXIS_TRIGGERLEFT));
-    /* Right trigger axis */
+    /* @return [Integer] index for Right trigger axis */
     rb_define_const(mAxis, "TRIGGERRIGHT", INT2NUM(SDL_CONTROLLER_AXIS_TRIGGERRIGHT));
-    /* The max of an axis index */
+    /* @return [Integer] the max value of axis indices */
     rb_define_const(mAxis, "MAX", INT2NUM(SDL_CONTROLLER_AXIS_MAX));
 
     /*  */
-    /* Invalid button index */
+    /* @return [Integer] index for Invalid button */
     rb_define_const(mButton, "INVALID", INT2NUM(SDL_CONTROLLER_BUTTON_INVALID));
-    /* Button A */
+    /* @return [Integer] index for Button A */
     rb_define_const(mButton, "A", INT2NUM(SDL_CONTROLLER_BUTTON_A));
-    /* Button B */
+    /* @return [Integer] index for Button B */
     rb_define_const(mButton, "B", INT2NUM(SDL_CONTROLLER_BUTTON_B));
-    /* Button X */
+    /* @return [Integer] index for Button X */
     rb_define_const(mButton, "X", INT2NUM(SDL_CONTROLLER_BUTTON_X));
-    /* Button Y */
+    /* @return [Integer] index for Button Y */
     rb_define_const(mButton, "Y", INT2NUM(SDL_CONTROLLER_BUTTON_Y));
-    /* Back Button */
+    /* @return [Integer] index for Back Button */
     rb_define_const(mButton, "BACK", INT2NUM(SDL_CONTROLLER_BUTTON_BACK));
-    /* Guide Button */
+    /* @return [Integer] index for Guide Button */
     rb_define_const(mButton, "GUIDE", INT2NUM(SDL_CONTROLLER_BUTTON_GUIDE));
-    /* Start Button */
+    /* @return [Integer] index for Start Button */
     rb_define_const(mButton, "START", INT2NUM(SDL_CONTROLLER_BUTTON_START));
-    /* Left stick Button */
+    /* @return [Integer] index for Left stick Button */
     rb_define_const(mButton, "LEFTSTICK", INT2NUM(SDL_CONTROLLER_BUTTON_LEFTSTICK));
-    /* Right stick Button */
+    /* @return [Integer] index for Right stick Button */
     rb_define_const(mButton, "RIGHTSTICK", INT2NUM(SDL_CONTROLLER_BUTTON_RIGHTSTICK));
-    /* Left shoulder Button */
+    /* @return [Integer] index for Left shoulder Button */
     rb_define_const(mButton, "LEFTSHOULDER", INT2NUM(SDL_CONTROLLER_BUTTON_LEFTSHOULDER));
-    /* Right shoulder Button */
+    /* @return [Integer] index for Right shoulder Button */
     rb_define_const(mButton, "RIGHTSHOULDER", INT2NUM(SDL_CONTROLLER_BUTTON_RIGHTSHOULDER));
-    /* D-pad UP Button */
+    /* @return [Integer] index for D-pad UP Button */
     rb_define_const(mButton, "DPAD_UP", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_UP));
-    /* D-pad DOWN Button */
+    /* @return [Integer] index for D-pad DOWN Button */
     rb_define_const(mButton, "DPAD_DOWN", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_DOWN));
-    /* D-pad LEFT Button */
+    /* @return [Integer] index for D-pad LEFT Button */
     rb_define_const(mButton, "DPAD_LEFT", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_LEFT));
-    /* D-pad RIGHT Button */
+    /* @return [Integer] index for D-pad RIGHT Button */
     rb_define_const(mButton, "DPAD_RIGHT", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_RIGHT));
-    /* The max of a button index */
+    /* @return [Integer] The max value of button indices */
     rb_define_const(mButton, "MAX", INT2NUM(SDL_CONTROLLER_BUTTON_MAX));
 }

data/gamecontroller.c.m4

@@ -302,6 +302,7 @@ static VALUE GameController_axis(VALUE self, VALUE axis)
  *   Return true if a button is pressed.
  *   
  *   @param button [Integer] the index of a button, one of the constants in {Button}
+ *   @return [Boolean]
  */
 static VALUE GameController_button_pressed_p(VALUE self, VALUE button)
 {
@@ -353,56 +354,56 @@ void rubysdl2_init_gamecontorller(void)
     mButton = rb_define_module_under(cGameController, "Button");
 
     /* define(`DEFINE_CONTROLLER_AXIS_CONST',`rb_define_const(mAxis, "$1", INT2NUM(SDL_CONTROLLER_AXIS_$1))') */
-    /* Invalid axis index */
+    /* @return [Integer] index for invalid axis*/
     DEFINE_CONTROLLER_AXIS_CONST(INVALID);
-    /* Left X axis */
+    /* @return [Integer] index for Left X axis */
     DEFINE_CONTROLLER_AXIS_CONST(LEFTX);
-    /* Left Y axis */
+    /* @return [Integer] index for Left Y axis */
     DEFINE_CONTROLLER_AXIS_CONST(LEFTY);
-    /* Right X axis */
+    /* @return [Integer] index for Right X axis */
     DEFINE_CONTROLLER_AXIS_CONST(RIGHTX);
-    /* Right Y axis */
+    /* @return [Integer] index for Right Y axis */
     DEFINE_CONTROLLER_AXIS_CONST(RIGHTY);
-    /* Left trigger axis */
+    /* @return [Integer] index for Left trigger axis */
     DEFINE_CONTROLLER_AXIS_CONST(TRIGGERLEFT);
-    /* Right trigger axis */
+    /* @return [Integer] index for Right trigger axis */
     DEFINE_CONTROLLER_AXIS_CONST(TRIGGERRIGHT);
-    /* The max of an axis index */
+    /* @return [Integer] the max value of axis indices */
     DEFINE_CONTROLLER_AXIS_CONST(MAX);
 
     /* define(`DEFINE_CONTROLLER_BUTTON_CONST',`rb_define_const(mButton, "$1", INT2NUM(SDL_CONTROLLER_BUTTON_$1))') */
-    /* Invalid button index */
+    /* @return [Integer] index for Invalid button */
     DEFINE_CONTROLLER_BUTTON_CONST(INVALID);
-    /* Button A */
+    /* @return [Integer] index for Button A */
     DEFINE_CONTROLLER_BUTTON_CONST(A);
-    /* Button B */
+    /* @return [Integer] index for Button B */
     DEFINE_CONTROLLER_BUTTON_CONST(B);
-    /* Button X */
+    /* @return [Integer] index for Button X */
     DEFINE_CONTROLLER_BUTTON_CONST(X);
-    /* Button Y */
+    /* @return [Integer] index for Button Y */
     DEFINE_CONTROLLER_BUTTON_CONST(Y);
-    /* Back Button */
+    /* @return [Integer] index for Back Button */
     DEFINE_CONTROLLER_BUTTON_CONST(BACK);
-    /* Guide Button */
+    /* @return [Integer] index for Guide Button */
     DEFINE_CONTROLLER_BUTTON_CONST(GUIDE);
-    /* Start Button */
+    /* @return [Integer] index for Start Button */
     DEFINE_CONTROLLER_BUTTON_CONST(START);
-    /* Left stick Button */
+    /* @return [Integer] index for Left stick Button */
     DEFINE_CONTROLLER_BUTTON_CONST(LEFTSTICK);
-    /* Right stick Button */
+    /* @return [Integer] index for Right stick Button */
     DEFINE_CONTROLLER_BUTTON_CONST(RIGHTSTICK);
-    /* Left shoulder Button */
+    /* @return [Integer] index for Left shoulder Button */
     DEFINE_CONTROLLER_BUTTON_CONST(LEFTSHOULDER);
-    /* Right shoulder Button */
+    /* @return [Integer] index for Right shoulder Button */
     DEFINE_CONTROLLER_BUTTON_CONST(RIGHTSHOULDER);
-    /* D-pad UP Button */
+    /* @return [Integer] index for D-pad UP Button */
     DEFINE_CONTROLLER_BUTTON_CONST(DPAD_UP);
-    /* D-pad DOWN Button */
+    /* @return [Integer] index for D-pad DOWN Button */
     DEFINE_CONTROLLER_BUTTON_CONST(DPAD_DOWN);
-    /* D-pad LEFT Button */
+    /* @return [Integer] index for D-pad LEFT Button */
     DEFINE_CONTROLLER_BUTTON_CONST(DPAD_LEFT);
-    /* D-pad RIGHT Button */
+    /* @return [Integer] index for D-pad RIGHT Button */
     DEFINE_CONTROLLER_BUTTON_CONST(DPAD_RIGHT);
-    /* The max of a button index */
+    /* @return [Integer] The max value of button indices */
     DEFINE_CONTROLLER_BUTTON_CONST(MAX);
 }

data/gl.c

@@ -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);
 
     /*  */
-    /* 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 +274,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 +284,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));