comparison libinterp/parse-tree/pt-eval.cc @ 20163:075a5e2e1ba5 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 19755f4fc851
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
1257 "-*- texinfo -*-\n\ 1257 "-*- texinfo -*-\n\
1258 @deftypefn {Built-in Function} {@var{val} =} max_recursion_depth ()\n\ 1258 @deftypefn {Built-in Function} {@var{val} =} max_recursion_depth ()\n\
1259 @deftypefnx {Built-in Function} {@var{old_val} =} max_recursion_depth (@var{new_val})\n\ 1259 @deftypefnx {Built-in Function} {@var{old_val} =} max_recursion_depth (@var{new_val})\n\
1260 @deftypefnx {Built-in Function} {} max_recursion_depth (@var{new_val}, \"local\")\n\ 1260 @deftypefnx {Built-in Function} {} max_recursion_depth (@var{new_val}, \"local\")\n\
1261 Query or set the internal limit on the number of times a function may\n\ 1261 Query or set the internal limit on the number of times a function may\n\
1262 be called recursively. If the limit is exceeded, an error message is\n\ 1262 be called recursively.\n\
1263 printed and control returns to the top level.\n\ 1263 \n\
1264 If the limit is exceeded, an error message is printed and control returns to\n\
1265 the top level.\n\
1264 \n\ 1266 \n\
1265 When called from inside a function with the @qcode{\"local\"} option, the\n\ 1267 When called from inside a function with the @qcode{\"local\"} option, the\n\
1266 variable is changed locally for the function and any subroutines it calls.\n\ 1268 variable is changed locally for the function and any subroutines it calls.\n\
1267 The original variable value is restored when exiting the function.\n\ 1269 The original variable value is restored when exiting the function.\n\
1268 @end deftypefn") 1270 @end deftypefn")
1286 "-*- texinfo -*-\n\ 1288 "-*- texinfo -*-\n\
1287 @deftypefn {Built-in Function} {@var{val} =} silent_functions ()\n\ 1289 @deftypefn {Built-in Function} {@var{val} =} silent_functions ()\n\
1288 @deftypefnx {Built-in Function} {@var{old_val} =} silent_functions (@var{new_val})\n\ 1290 @deftypefnx {Built-in Function} {@var{old_val} =} silent_functions (@var{new_val})\n\
1289 @deftypefnx {Built-in Function} {} silent_functions (@var{new_val}, \"local\")\n\ 1291 @deftypefnx {Built-in Function} {} silent_functions (@var{new_val}, \"local\")\n\
1290 Query or set the internal variable that controls whether internal\n\ 1292 Query or set the internal variable that controls whether internal\n\
1291 output from a function is suppressed. If this option is disabled,\n\ 1293 output from a function is suppressed.\n\
1292 Octave will display the results produced by evaluating expressions\n\ 1294 \n\
1293 within a function body that are not terminated with a semicolon.\n\ 1295 If this option is disabled, Octave will display the results produced by\n\
1296 evaluating expressions within a function body that are not terminated with\n\
1297 a semicolon.\n\
1294 \n\ 1298 \n\
1295 When called from inside a function with the @qcode{\"local\"} option, the\n\ 1299 When called from inside a function with the @qcode{\"local\"} option, the\n\
1296 variable is changed locally for the function and any subroutines it calls.\n\ 1300 variable is changed locally for the function and any subroutines it calls.\n\
1297 The original variable value is restored when exiting the function.\n\ 1301 The original variable value is restored when exiting the function.\n\
1298 @end deftypefn") 1302 @end deftypefn")