Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/svd.cc @ 13951:79aa00a94e9e
doc: Document "local" option for configuration variables.
* svd.cc, defaults.cc, dirfns.cc, error.cc, help.cc, input.cc, load-save.cc,
ls-oct-ascii.cc, oct-hist.cc, ov-base.cc, ov-range.cc, ov-struct.cc,
ov-usr-fcn.cc, pager.cc, pr-output.cc, pt-binop.cc, pt-eval.cc, pt-mat.cc,
sighandlers.cc, variables.cc: Document "local" option for configuration
variables.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 27 Nov 2011 16:07:13 -0800 |
parents | 5fa482628bf6 |
children | 72c96de7a403 |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/svd.cc Sun Nov 27 09:01:37 2011 -0500 +++ b/src/DLD-FUNCTIONS/svd.cc Sun Nov 27 16:07:13 2011 -0800 @@ -408,9 +408,14 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{val} =} svd_driver ()\n\ @deftypefnx {Loadable Function} {@var{old_val} =} svd_driver (@var{new_val})\n\ +@deftypefnx {Loadable Function} {} svd_driver (@var{new_val}, \"local\")\n\ Query or set the underlying @sc{lapack} driver used by @code{svd}.\n\ Currently recognized values are \"gesvd\" and \"gesdd\". The default\n\ is \"gesvd\".\n\ +\n\ +When called from inside a function with the \"local\" option, the variable is\n\ +changed locally for the function and any subroutines it calls. The original\n\ +variable value is restored when exiting the function.\n\ @seealso{svd}\n\ @end deftypefn") {