Mercurial > octave-dspies

diff libinterp/corefcn/sysdep.cc @ 18674:7bccc182e2f7 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update pause documentation and add seealso links between related functions. * input.cc (Finput): Put first sentence description on its own line. Add seealso links. * input.cc (Fyes_or_no):Put first sentence description on its own line. Add seealso links. * input.cc (Fkeyboard): Add seealso link to dbstop. * input.cc (Fkeyboard): Add seealso link to dbstop. * sysdep.cc (Fkbhit): Add seealso link to pause. * sysdep.cc (Fpause): Rewrite docstring. Add seealso links. * sysdep.cc (Fsleep): Add seealso links to usleep, pause. * sysdep.cc (Fusleep): Add seealso links to sleep, pause. * sysdep.cc (Fhave_window_system): Correct bad phrasing in docstring. * listdlg.m: Add seealso link to menu * menu.m: Add seealso link to listdlg.
author Rik <rik@octave.org>
date Thu, 24 Apr 2014 20:23:48 -0700
parents af685269e06c
children
line wrap: on
line diff
--- a/libinterp/corefcn/sysdep.cc	Thu Apr 24 09:22:38 2014 -0700
+++ b/libinterp/corefcn/sysdep.cc	Thu Apr 24 20:23:48 2014 -0700
@@ -641,7 +641,7 @@
 @noindent\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\
+@seealso{input, pause}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -667,12 +667,16 @@
 
 DEFUN (pause, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} pause (@var{seconds})\n\
-Suspend the execution of the program.  If invoked without any arguments,\n\
-Octave waits until you type a character.  With a numeric argument, it\n\
-pauses for the given number of seconds.  For example, the following\n\
-statement prints a message and then waits 5 seconds before clearing the\n\
-screen.\n\
+@deftypefn  {Built-in Function} {} pause ()\n\
+@deftypefnx {Built-in Function} {} pause (@var{n})\n\
+Suspend the execution of the program for @var{n} seconds.\n\
+\n\
+@var{n} is a positive real value and may be a fraction of a second.\n\
+If invoked without an input arguments then the program is suspended until a\n\
+character is typed.\n\
+\n\
+The following example prints a message and then waits 5 seconds before\n\
+clearing the screen.\n\
 \n\
 @example\n\
 @group\n\
@@ -681,6 +685,7 @@
 clc;\n\
 @end group\n\
 @end example\n\
+@seealso{kbhit, sleep}\n\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -736,6 +741,7 @@
        "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} sleep (@var{seconds})\n\
 Suspend the execution of the program for the given number of seconds.\n\
+@seealso{usleep, pause}\n\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -776,6 +782,7 @@
 microseconds.  On systems where it is not possible to sleep for periods\n\
 of time less than one second, @code{usleep} will pause the execution for\n\
 @code{round (@var{microseconds} / 1e6)} seconds.\n\
+@seealso{sleep, pause}\n\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -915,8 +922,8 @@
 DEFUN (have_window_system, , ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} have_window_system ()\n\
-Return true if Octave a window system is available (X11, Windows,\n\
-or Apple OS X) and false otherwise.\n\
+Return true if a window system is available (X11, Windows, or Apple OS X)\n\
+and false otherwise.\n\
 @end deftypefn")
 {
   return octave_value (display_info::display_available ());