Mercurial > hg > octave-lyh
changeset 17177:9ba57ed05207
doc: Rewrite docstring for diary() to show available calling options.
* libinterp/corefcn/pager.cc: Rewrite docstring for diary() to show available
calling options.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 04 Aug 2013 11:57:26 -0700 |
parents | 19191d0ef0bf |
children | d6499c14021c |
files | libinterp/corefcn/pager.cc |
diffstat | 1 files changed, 13 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/pager.cc +++ b/libinterp/corefcn/pager.cc @@ -514,23 +514,29 @@ DEFUN (diary, args, , "-*- texinfo -*-\n\ -@deftypefn {Command} {} diary options\n\ +@deftypefn {Command} {} diary\n\ +@deftypefnx {Command} {} diary on\n\ +@deftypefnx {Command} {} diary off\n\ +@deftypefnx {Command} {} diary @var{filename}\n\ Record a list of all commands @emph{and} the output they produce, mixed\n\ -together just as you see them on your terminal. Valid options are:\n\ +together just as they appear on the terminal.\n\ \n\ -@table @code\n\ +Valid options are:\n\ +\n\ +@table @asis\n\ @item on\n\ -Start recording your session in a file called @file{diary} in your\n\ +Start recording a session in a file called @file{diary} in the\n\ current working directory.\n\ \n\ @item off\n\ -Stop recording your session in the diary file.\n\ +Stop recording the session in the diary file.\n\ \n\ -@item @var{file}\n\ -Record your session in the file named @var{file}.\n\ +@item @var{filename}\n\ +Record the session in the file named @var{filename}.\n\ @end table\n\ \n\ With no arguments, @code{diary} toggles the current diary state.\n\ +@seealso{history}\n\ @end deftypefn") { octave_value_list retval;