Permalink
Browse files

Added documentation comment for the Rubygame::Events module.

  • Loading branch information...
1 parent 9d35bcd commit 034fa79a30b78ae80f208e83f188d3b6f3b688bc @jacius jacius committed Jun 19, 2008
Showing with 17 additions and 0 deletions.
  1. +17 −0 lib/rubygame/events.rb
View
@@ -20,6 +20,23 @@
#++
+module Rubygame
+
+ # The Events module contains classes representing various
+ # hardware events (e.g. keyboard presses, mouse clicks)
+ # and software events (e.g. clock tick, window becomes active)
+ #
+ # This event classes are meant as a full replacement for
+ # the older event classes defined in the Rubygame module
+ # (e.g. KeyDownEvent, QuitEvent). The old classes are
+ # deprecated and should not be used anymore.
+ #
+ module Events
+ end
+
+end
+
+
# Load all the ruby files in events/
glob = File.join( File.dirname(__FILE__), "events", "*.rb" )
Dir.glob( glob ).each do |path|

0 comments on commit 034fa79

Please sign in to comment.