diff options
| author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-25 00:57:07 +0000 |
|---|---|---|
| committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-25 00:57:07 +0000 |
| commit | eab122534dbff7f79f9b01a5e36aeb730ee24acf (patch) | |
| tree | 78e54b9cb52ff2e03bd2fb873d4acc483abb53e2 /ext/curses/curses.c | |
| parent | 5bf1c145d4b3dbcc5936e0d950752fa6d4474366 (diff) | |
* ext/curses/curses.c: Add missing documentation for button state, MIN
and MAX comments. Add Curses. to TABSIZE= and ESCDELAY= methods.
[Ruby 1.9 - Bug #4747]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31730 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/curses/curses.c')
| -rw-r--r-- | ext/curses/curses.c | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/ext/curses/curses.c b/ext/curses/curses.c index 3778c27df3..b8e3bfa760 100644 --- a/ext/curses/curses.c +++ b/ext/curses/curses.c @@ -957,7 +957,7 @@ curses_use_default_colors(VALUE obj) #if defined(HAVE_TABSIZE) /* - * Document-method: TABSIZE= + * Document-method: Curses.TABSIZE= * call-seq: TABSIZE=(value) * * Sets the TABSIZE to Integer +value+ @@ -987,7 +987,7 @@ curses_tabsize_get(VALUE ojb) #if defined(HAVE_ESCDELAY) /* - * call-seq: ESCDELAY=(value) + * call-seq: Curses.ESCDELAY=(value) * * Sets the ESCDELAY to Integer +value+ */ @@ -1359,9 +1359,8 @@ DEFINE_MOUSE_GET_MEMBER(curs_mouse_z, z) /* * Document-method: Curses::MouseEvent.bstate * - * Returns the current mouse's B state. - * - * ??? + * Returns the current mouse's button state. Use this with the button state + * constants to determine which buttons were pressed. */ DEFINE_MOUSE_GET_MEMBER(curs_mouse_bstate, bstate) #undef define_curs_mouse_member @@ -2883,7 +2882,7 @@ Init_curses(void) #ifdef KEY_MIN /* Document-const: MIN * - * ??? + * The minimum allowed curses key value. */ rb_curses_define_const(KEY_MIN); rb_define_const(mKey, "MIN", INT2NUM(KEY_MIN)); @@ -3616,7 +3615,7 @@ Init_curses(void) #ifdef KEY_MAX /* Document-const: MAX * - * ??? + * The maximum allowed curses key value. */ rb_curses_define_const(KEY_MAX); rb_define_const(mKey, "MAX", INT2NUM(KEY_MAX)); |