Mercurial > hg > octave-lyh

diff src/pt-mat.cc @ 13951:79aa00a94e9e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 0a158dbdb04a
children 72c96de7a403
line wrap: on
line diff
--- a/src/pt-mat.cc
+++ b/src/pt-mat.cc
@@ -1391,6 +1391,7 @@
   "-*- texinfo -*-\n\
 @deftypefn  {Built-in Function} {@var{val} =} string_fill_char ()\n\
 @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\
+@deftypefnx {Built-in Function} {} string_fill_char (@var{new_val}, \"local\")\n\
 Query or set the internal variable used to pad all rows of a character\n\
 matrix to the same length.  It must be a single character.  The default\n\
 value is @code{\" \"} (a single space).  For example:\n\
@@ -1404,6 +1405,10 @@
         \"strings\"\n\
 @end group\n\
 @end example\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\
 @end deftypefn")
 {
   return SET_INTERNAL_VARIABLE (string_fill_char);