Mercurial > hg > octave-nkf

comparison src/variables.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 2a8dcb5b3a00
children fc9f204faea0
comparison
equal deleted inserted replaced
13949:0c15fece33ad 13951:79aa00a94e9e
2460 2460
2461 DEFUN (whos_line_format, args, nargout, 2461 DEFUN (whos_line_format, args, nargout,
2462 "-*- texinfo -*-\n\ 2462 "-*- texinfo -*-\n\
2463 @deftypefn {Built-in Function} {@var{val} =} whos_line_format ()\n\ 2463 @deftypefn {Built-in Function} {@var{val} =} whos_line_format ()\n\
2464 @deftypefnx {Built-in Function} {@var{old_val} =} whos_line_format (@var{new_val})\n\ 2464 @deftypefnx {Built-in Function} {@var{old_val} =} whos_line_format (@var{new_val})\n\
2465 @deftypefnx {Built-in Function} {} whos_line_format (@var{new_val}, \"local\")\n\
2465 Query or set the format string used by the command @code{whos}.\n\ 2466 Query or set the format string used by the command @code{whos}.\n\
2466 \n\ 2467 \n\
2467 A full format string is:\n\ 2468 A full format string is:\n\
2468 @c Set example in small font to prevent overfull line\n\ 2469 @c Set example in small font to prevent overfull line\n\
2469 \n\ 2470 \n\
2521 leftmost column. @code{left-min} specifies the minimum field width to the\n\ 2522 leftmost column. @code{left-min} specifies the minimum field width to the\n\
2522 left of the specified balance column.\n\ 2523 left of the specified balance column.\n\
2523 \n\ 2524 \n\
2524 The default format is\n\ 2525 The default format is\n\
2525 @code{\" %a:4; %ln:6; %cs:16:6:1; %rb:12; %lc:-1;\\n\"}.\n\ 2526 @code{\" %a:4; %ln:6; %cs:16:6:1; %rb:12; %lc:-1;\\n\"}.\n\
2527 \n\
2528 When called from inside a function with the \"local\" option, the variable is\n\
2529 changed locally for the function and any subroutines it calls. The original\n\
2530 variable value is restored when exiting the function.\n\
2526 @seealso{whos}\n\ 2531 @seealso{whos}\n\
2527 @end deftypefn") 2532 @end deftypefn")
2528 { 2533 {
2529 return SET_INTERNAL_VARIABLE (whos_line_format); 2534 return SET_INTERNAL_VARIABLE (whos_line_format);
2530 } 2535 }
2533 2538
2534 DEFUN (missing_function_hook, args, nargout, 2539 DEFUN (missing_function_hook, args, nargout,
2535 "-*- texinfo -*-\n\ 2540 "-*- texinfo -*-\n\
2536 @deftypefn {Built-in Function} {@var{val} =} missing_function_hook ()\n\ 2541 @deftypefn {Built-in Function} {@var{val} =} missing_function_hook ()\n\
2537 @deftypefnx {Built-in Function} {@var{old_val} =} missing_function_hook (@var{new_val})\n\ 2542 @deftypefnx {Built-in Function} {@var{old_val} =} missing_function_hook (@var{new_val})\n\
2543 @deftypefnx {Built-in Function} {} missing_function_hook (@var{new_val}, \"local\")\n\
2538 Query or set the internal variable that specifies the function to call when\n\ 2544 Query or set the internal variable that specifies the function to call when\n\
2539 an unknown identifier is requested.\n\ 2545 an unknown identifier is requested.\n\
2546 \n\
2547 When called from inside a function with the \"local\" option, the variable is\n\
2548 changed locally for the function and any subroutines it calls. The original\n\
2549 variable value is restored when exiting the function.\n\
2540 @end deftypefn") 2550 @end deftypefn")
2541 { 2551 {
2542 return SET_INTERNAL_VARIABLE (missing_function_hook); 2552 return SET_INTERNAL_VARIABLE (missing_function_hook);
2543 } 2553 }
2544 2554