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

[ruby/io-console] [DOC] Improved about intr:

Browse Source 
https://github.com/ruby/io-console/commit/82b630cd79
This commit is contained in:
Nobuyoshi Nakada 2020-02-17 12:02:58 +09:00
parent 21ab483614
commit dec802d8b5
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -360,9 +360,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
/* /*
* call-seq: * call-seq:
* io.raw(min: nil, time: nil) {|io| } * io.raw(min: nil, time: nil, intr: nil) {|io| }
* *
* Yields +self+ within raw mode. * Yields +self+ within raw mode, and returns the result of the block.
* *
* STDIN.raw(&:gets) * STDIN.raw(&:gets)
* *
@ -374,6 +374,9 @@ ttymode_with_io(VALUE io, VALUE (*func)(VALUE, VALUE), VALUE farg, void (*setter
* The parameter +time+ specifies the timeout in _seconds_ with a * The parameter +time+ specifies the timeout in _seconds_ with a
* precision of 1/10 of a second. (default: 0) * precision of 1/10 of a second. (default: 0)
* *
* If the parameter +intr+ is +true+, enables break, interrupt, quit,
* and suspend special characters.
*
* Refer to the manual page of termios for further details. * Refer to the manual page of termios for further details.
* *
* You must require 'io/console' to use this method. * You must require 'io/console' to use this method.
@ -387,11 +390,11 @@ console_raw(int argc, VALUE *argv, VALUE io)
/* /*
* call-seq: * call-seq:
* io.raw!(min: nil, time: nil) * io.raw!(min: nil, time: nil, intr: nil) -> io
* *
* Enables raw mode. * Enables raw mode, and returns +io+.
* *
* If the terminal mode needs to be back, use io.raw { ... }. * If the terminal mode needs to be back, use <code>io.raw { ... }</code>.
* *
* See IO#raw for details on the parameters. * See IO#raw for details on the parameters.
* *
@ -487,7 +490,7 @@ nogvl_getch(void *p)
/* /*
* call-seq: * call-seq:
* io.getch(min: nil, time: nil) -> char * io.getch(min: nil, time: nil, intr: nil) -> char
* *
* Reads and returns a character in raw mode. * Reads and returns a character in raw mode.
* *
@ -1494,7 +1497,7 @@ console_dev(int argc, VALUE *argv, VALUE klass)
/* /*
* call-seq: * call-seq:
* io.getch(min: nil, time: nil) -> char * io.getch(min: nil, time: nil, intr: nil) -> char
* *
* See IO#getch. * See IO#getch.
*/ */