Mercurial > hg > octave-nkf
diff libinterp/interpfcn/sysdep.cc @ 16053:119ce9f5e1a3
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 |
line wrap: on
line diff
--- a/libinterp/interpfcn/sysdep.cc +++ b/libinterp/interpfcn/sysdep.cc @@ -619,8 +619,9 @@ DEFUN (kbhit, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} kbhit ()\n\ -Read a single keystroke from the keyboard. If called with one\n\ +@deftypefn {Built-in Function} {} kbhit ()\n\ +@deftypefnx {Built-in Function} {} kbhit (1)\n\ +Read a single keystroke from the keyboard. If called with an\n\ argument, don't wait for a keypress. For example,\n\ \n\ @example\n\ @@ -636,8 +637,9 @@ @end example\n\ \n\ @noindent\n\ -identical to the above example, but don't wait for a keypress,\n\ +is identical to the above example, but doesn't wait for a keypress,\n\ returning the empty string if no key is available.\n\ +@seealso{input}\n\ @end deftypefn") { octave_value retval;