[前][次][番号順一覧][スレッド一覧]

ruby-changes:19685

From: drbrain <ko1@a...>
Date: Wed, 25 May 2011 09:57:13 +0900 (JST)
Subject: [ruby-changes:19685] drbrain:r31730 (trunk): * ext/curses/curses.c: Add missing documentation for button state, MIN

drbrain	2011-05-25 09:57:07 +0900 (Wed, 25 May 2011)

  New Revision: 31730

  http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=31730

  Log:
    * 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]

  Modified files:
    trunk/ChangeLog
    trunk/ext/curses/curses.c

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 31729)
+++ ChangeLog	(revision 31730)
@@ -1,3 +1,9 @@
+Wed May 25 09:56:45 2011  Eric Hodel  <drbrain@s...>
+
+	* 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]
+
 Wed May 25 09:35:31 2011  Eric Hodel  <drbrain@s...>
 
 	* lib/benchmark.rb:  Restore nodoc for Benchmark::Job and
Index: ext/curses/curses.c
===================================================================
--- ext/curses/curses.c	(revision 31729)
+++ ext/curses/curses.c	(revision 31730)
@@ -957,7 +957,7 @@
 
 #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 @@
 
 #if defined(HAVE_ESCDELAY)
 /*
- * call-seq: ESCDELAY=(value)
+ * call-seq: Curses.ESCDELAY=(value)
  *
  * Sets the ESCDELAY to Integer +value+
  */
@@ -1359,9 +1359,8 @@
 /*
  * 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 @@
 #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 @@
 #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));

--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]