Mercurial > octave

diff libinterp/corefcn/utils.cc @ 25106:d7ad543255c5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Shorten very long first sentences of docstrings (bug #53388). * bsxfun.cc (Fbsxfun), daspk.cc (Fdaspk), dasrt.cc (Fdasrt), dassl.cc (Fdassl), gsvd.cc (Fgsvd), load-save.cc (Foctave_core_file_limit), qz.cc (Fqz), svd.cc (Fsvd), sylvester.cc (Fsylvester), utils.cc (Ferrno), bincoeff.m, bessel.m, krylov.m, expint.m, moment.m: Shorten very long first sentences.
author Rik <rik@octave.org>
date Tue, 03 Apr 2018 21:37:29 -0700
parents 078b795c5219
children 5960fd1b56f1 7b1b504c2f12
line wrap: on
line diff
--- a/libinterp/corefcn/utils.cc	Tue Apr 03 12:15:41 2018 +0200
+++ b/libinterp/corefcn/utils.cc	Tue Apr 03 21:37:29 2018 -0700
@@ -1047,10 +1047,17 @@
 @deftypefn  {} {@var{err} =} errno ()
 @deftypefnx {} {@var{err} =} errno (@var{val})
 @deftypefnx {} {@var{err} =} errno (@var{name})
-Return the current value of the system-dependent variable errno,
-set its value to @var{val} and return the previous value, or return
-the named error code given @var{name} as a character string, or -1
-if @var{name} is not found.
+Query or set the system-dependent variable errno.
+
+When called with no inputs, return the current value of errno.
+
+When called with a numeric input @var{val}, set the current value of errno
+to the specified value.  The previous value of errno is returned as @var{err}.
+
+When called with a character string @var{name}, return the numeric value of
+errno which corresponds to the specified error code.  If @var{name} is not
+a recognized error code then -1 is returned.
+
 @seealso{errno_list}
 @end deftypefn */)
 {