Mercurial > hg > octave-lojdl
changeset 12692:e7b03b8662a2 stable
doc: Update docstrings for a few functions
* error.cc (lasterr, lasterror): Update lasterr with additional calling forms,
rewrite lasterror docstring
* variables.cc (munlock, mislocked): Add additional calling forms to docstring.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 25 May 2011 21:07:00 -0700 |
parents | 2cf5f81c5ad6 |
children | abc71e3148ac |
files | src/error.cc src/variables.cc |
diffstat | 2 files changed, 25 insertions(+), 20 deletions(-) [+] |
line wrap: on
line diff
--- a/src/error.cc +++ b/src/error.cc @@ -1480,9 +1480,9 @@ @deftypefn {Built-in Function} {@var{lasterr} =} lasterror ()\n\ @deftypefnx {Built-in Function} {} lasterror (@var{err})\n\ @deftypefnx {Built-in Function} {} lasterror ('reset')\n\ -Query or set the last error message. Called without any arguments\n\ -returns a structure containing the last error message, as well as other\n\ -information related to this error. The elements of this structure are:\n\ +Query or set the last error message structure. When called without arguments\n\ +, return a structure containing the last error message and other\n\ +information related to this error. The elements of the structure are:\n\ \n\ @table @asis\n\ @item 'message'\n\ @@ -1492,9 +1492,9 @@ The message identifier of this error message\n\ \n\ @item 'stack'\n\ -A structure containing information on where the message occurred. This might\n\ -be an empty structure if this in the case where this information cannot\n\ -be obtained. The fields of this structure are:\n\ +A structure containing information on where the message occurred. This may\n\ +be an empty structure if the information cannot\n\ +be obtained. The fields of the structure are:\n\ \n\ @table @asis\n\ @item 'file'\n\ @@ -1511,14 +1511,13 @@ @end table\n\ @end table\n\ \n\ -The @var{err} structure may also be passed to @code{lasterror} to set the\n\ -information about the last error. The only constraint on @var{err} in that\n\ -case is that it is a scalar structure. Any fields of @var{err} that match\n\ -the above are set to the value passed in @var{err}, while other fields are\n\ +The last error structure may be set by passing a scalar structure, @var{err},\n\ +as input. Any fields of @var{err} that match those above are set while any\n\ +unspecified fields are initialized with default values.\n\ +\n\ +If @code{lasterror} is called with the argument 'reset', all fields are\n\ set to their default values.\n\ -\n\ -If @code{lasterror} is called with the argument 'reset', all values take\n\ -their default values.\n\ +@seealso{lasterr}\n\ @end deftypefn") { octave_value retval; @@ -1636,10 +1635,14 @@ DEFUN (lasterr, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} lasterr (@var{msg}, @var{msgid})\n\ -Without any arguments, return the last error message. With one\n\ +@deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} lasterr ()\n\ +@deftypefnx {Built-in Function} {} lasterr (@var{msg})\n\ +@deftypefnx {Built-in Function} {} lasterr (@var{msg}, @var{msgid})\n\ +Query or set the last error message. When called without input arguments,\n\ +return the last error message and message identifier. With one\n\ argument, set the last error message to @var{msg}. With two arguments,\n\ also set the last message identifier.\n\ +@seealso{lasterror}\n\ @end deftypefn") { octave_value_list retval;
--- a/src/variables.cc +++ b/src/variables.cc @@ -1955,8 +1955,9 @@ DEFUN (munlock, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} munlock (@var{fcn})\n\ -Unlock the named function. If no function is named\n\ +@deftypefn {Built-in Function} {} munlock ()\n\ +@deftypefnx {Built-in Function} {} munlock (@var{fcn})\n\ +Unlock the named function @var{fcn}. If no function is named\n\ then unlock the current function.\n\ @seealso{mlock, mislocked, persistent}\n\ @end deftypefn") @@ -1990,9 +1991,10 @@ DEFUN (mislocked, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} mislocked (@var{fcn})\n\ -Return true if the named function is locked. If no function is named\n\ -then return true if the current function is locked.\n\ +@deftypefn {Built-in Function} {} mislocked ()\n\ +@deftypefnx {Built-in Function} {} mislocked (@var{fcn})\n\ +Return true if the named function @var{fcn} is locked. If no function is\n\ +named then return true if the current function is locked.\n\ @seealso{mlock, munlock, persistent}\n\ @end deftypefn") {