Mercurial > hg > octave-lyh

comparison 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
comparison
equal deleted inserted replaced
13949:0c15fece33ad 13951:79aa00a94e9e
1389 1389
1390 DEFUN (string_fill_char, args, nargout, 1390 DEFUN (string_fill_char, args, nargout,
1391 "-*- texinfo -*-\n\ 1391 "-*- texinfo -*-\n\
1392 @deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\ 1392 @deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\
1393 @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\ 1393 @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\
1394 @deftypefnx {Built-in Function} {} string_fill_char (@var{new_val}, \"local\")\n\
1394 Query or set the internal variable used to pad all rows of a character\n\ 1395 Query or set the internal variable used to pad all rows of a character\n\
1395 matrix to the same length. It must be a single character. The default\n\ 1396 matrix to the same length. It must be a single character. The default\n\
1396 value is @code{\" \"} (a single space). For example:\n\ 1397 value is @code{\" \"} (a single space). For example:\n\
1397 \n\ 1398 \n\
1398 @example\n\ 1399 @example\n\
1402 @result{} \"theseXX\"\n\ 1403 @result{} \"theseXX\"\n\
1403 \"areXXXX\"\n\ 1404 \"areXXXX\"\n\
1404 \"strings\"\n\ 1405 \"strings\"\n\
1405 @end group\n\ 1406 @end group\n\
1406 @end example\n\ 1407 @end example\n\
1408 \n\
1409 When called from inside a function with the \"local\" option, the variable is\n\
1410 changed locally for the function and any subroutines it calls. The original\n\
1411 variable value is restored when exiting the function.\n\
1407 @end deftypefn") 1412 @end deftypefn")
1408 { 1413 {
1409 return SET_INTERNAL_VARIABLE (string_fill_char); 1414 return SET_INTERNAL_VARIABLE (string_fill_char);
1410 } 1415 }
1411 1416