1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add details on the min/time parameters to the rdoc

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60685 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
knu 2017-11-07 05:28:14 +00:00
parent 48ce4cb414
commit f477851bb7
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
ext/io/console/console.c
View File

@ -307,6 +307,15 @@ ttymode(VALUE io, VALUE (*func)(VALUE), void (*setter)(conmode *, void *), void
*
* will read and return a line without echo back and line editing.
*
* The parameter +min+ specifies the minimum number of bytes that
* should be received when the read operation is performed. (default:
* 1)
*
* The paramter +time+ specifies the timeout in _seconds_, with a
* precision of 1/10 of a second. (default: 0)
*
* Refer to the manual page of termios for further details.
*
* You must require 'io/console' to use this method.
*/
static VALUE
@ -324,6 +333,8 @@ console_raw(int argc, VALUE *argv, VALUE io)
*
* If the terminal mode needs to be back, use io.raw { ... }.
*
* See IO#raw for details on the parameters.
*
* You must require 'io/console' to use this method.
*/
static VALUE
@ -397,6 +408,8 @@ getc_call(VALUE io)
*
* Reads and returns a character in raw mode.
*
* See IO#raw for details on the parameters.
*
* You must require 'io/console' to use this method.
*/
static VALUE