# HG changeset patch # User Rik # Date 1244060497 25200 # Node ID fddb9f9f724b23fd2a87ee39c631eda7268246bf # Parent c8c03978832fb8529c387b3aad5fa29b899b6da1 Correct documentation for keyboard function diff -r c8c03978832f -r fddb9f9f724b src/ChangeLog --- a/src/ChangeLog Wed Jun 03 13:19:36 2009 -0700 +++ b/src/ChangeLog Wed Jun 03 13:21:37 2009 -0700 @@ -1,3 +1,7 @@ +2009-06-03 Rik + + * input.cc: Correct documentation for keyboard function + 2009-06-02 Rob Mahurin * Makefile.in: Add CARBON_LIBS to OCTINTERP_LINK_DEPS. diff -r c8c03978832f -r fddb9f9f724b src/input.cc --- a/src/input.cc Wed Jun 03 13:19:36 2009 -0700 +++ b/src/input.cc Wed Jun 03 13:21:37 2009 -0700 @@ -930,17 +930,19 @@ DEFUN (keyboard, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} keyboard (@var{prompt})\n\ +@deftypefn {Built-in Function} {} keyboard ()\n\ +@deftypefnx {Built-in Function} {} keyboard (@var{prompt})\n\ This function is normally used for simple debugging. When the\n\ @code{keyboard} function is executed, Octave prints a prompt and waits\n\ for user input. The input strings are then evaluated and the results\n\ are printed. This makes it possible to examine the values of variables\n\ -within a function, and to assign new values to variables. No value is\n\ -returned from the @code{keyboard} function, and it continues to prompt\n\ -for input until the user types @samp{quit}, or @samp{exit}.\n\ +within a function, and to assign new values if necessary. To leave the\n\ +prompt and return to normal execution type @samp{return} or @samp{dbcont}.\n\ +The @code{keyboard} function does not return an exit status.\n\ \n\ -If @code{keyboard} is invoked without any arguments, a default prompt of\n\ +If @code{keyboard} is invoked without arguments, a default prompt of\n\ @samp{debug> } is used.\n\ +@seealso{dbcont, dbquit}\n\ @end deftypefn") { octave_value_list retval;