Mercurial > octave-nkf

comparison libinterp/interpfcn/sysdep.cc @ 16053:119ce9f5e1a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add seealso links between input, yes_or_no, kbhit. * libinterp/interpfcn/input.cc(Finput): Add seealso link to yes_or_no, kbhit. Add return argument to function documenation. * libinterp/interpfcn/input.cc(Fyes_or_no): Add seealso link to input. Redo docstring to make it more modern. * libinterp/interpfcn/sysdep.cc(kbhit): Add seealso link to input. Add second calling form of kbhit to documentation.
author Rik <rik@octave.org>
date Tue, 12 Feb 2013 08:13:46 -0800
parents d910b9211cca
children def3b111cff8
comparison
equal deleted inserted replaced
16052:a59cb5c06d79 16053:119ce9f5e1a3
617 617
618 // FIXME -- perhaps kbhit should also be able to print a prompt? 618 // FIXME -- perhaps kbhit should also be able to print a prompt?
619 619
620 DEFUN (kbhit, args, , 620 DEFUN (kbhit, args, ,
621 "-*- texinfo -*-\n\ 621 "-*- texinfo -*-\n\
622 @deftypefn {Built-in Function} {} kbhit ()\n\ 622 @deftypefn {Built-in Function} {} kbhit ()\n\
623 Read a single keystroke from the keyboard. If called with one\n\ 623 @deftypefnx {Built-in Function} {} kbhit (1)\n\
624 Read a single keystroke from the keyboard. If called with an\n\
624 argument, don't wait for a keypress. For example,\n\ 625 argument, don't wait for a keypress. For example,\n\
625 \n\ 626 \n\
626 @example\n\ 627 @example\n\
627 x = kbhit ();\n\ 628 x = kbhit ();\n\
628 @end example\n\ 629 @end example\n\
634 @example\n\ 635 @example\n\
635 x = kbhit (1);\n\ 636 x = kbhit (1);\n\
636 @end example\n\ 637 @end example\n\
637 \n\ 638 \n\
638 @noindent\n\ 639 @noindent\n\
639 identical to the above example, but don't wait for a keypress,\n\ 640 is identical to the above example, but doesn't wait for a keypress,\n\
640 returning the empty string if no key is available.\n\ 641 returning the empty string if no key is available.\n\
642 @seealso{input}\n\
641 @end deftypefn") 643 @end deftypefn")
642 { 644 {
643 octave_value retval; 645 octave_value retval;
644 646
645 // FIXME -- add timeout and default value args? 647 // FIXME -- add timeout and default value args?