Skip to content

Commit

Permalink
Improve rdoc for Gosu::Window
Browse files Browse the repository at this point in the history
  • Loading branch information
jlnr committed May 17, 2015
1 parent 9aa4b60 commit 41d433c
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions rdoc/gosu.rb
Expand Up @@ -676,28 +676,27 @@ def filter text_in
# Gosu application. Manages initialization of all of Gosu's core components
# and provides timing functionality.
#
# Note that all coordinates, even the mouse position, are in client
# coordinates relative to the window. This means that the mouse position
# can be negative or larger than the window size.
# Note that all coordinates, even the mouse position, are in client coordinates, relative to the window’s top left corner.
# This means that the mouse position can be negative or larger than the window size.
#
# @note There should really only be one instance of this class at a time. This may or may not change later, but for right now, having two or more windows and loading samples or songs on both of them will result in an exception.
# @note There should really only be one instance of this class at a time. This may or may not change later.
class Window
##
# @return [String] the window's caption, usually dispalyed in the title bar.
attr_accessor :caption

##
# @return [Fixnum] the mouse pointer's window-based X coordinate.
# @return [Float] the mouse pointer's window-based X coordinate.
attr_accessor :mouse_x

##
# @return [Fixnum] the mouse pointer's window-based Y coordinate.
# @return [Float] the mouse pointer's window-based Y coordinate.
attr_accessor :mouse_y

##
# The currently active {TextInput}. If not nil, all keyboard input will be handled by this object.
#
# @return [TextInput?] the currently active text input.
# @return [TextInput?] the currently active text input, if any.
attr_accessor :text_input

##
Expand Down

0 comments on commit 41d433c

Please sign in to comment.