comparison libinterp/octave-value/ov-range.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 09ed6f7538dd
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
701 "-*- texinfo -*-\n\ 701 "-*- texinfo -*-\n\
702 @deftypefn {Built-in Function} {@var{val} =} allow_noninteger_range_as_index ()\n\ 702 @deftypefn {Built-in Function} {@var{val} =} allow_noninteger_range_as_index ()\n\
703 @deftypefnx {Built-in Function} {@var{old_val} =} allow_noninteger_range_as_index (@var{new_val})\n\ 703 @deftypefnx {Built-in Function} {@var{old_val} =} allow_noninteger_range_as_index (@var{new_val})\n\
704 @deftypefnx {Built-in Function} {} allow_noninteger_range_as_index (@var{new_val}, \"local\")\n\ 704 @deftypefnx {Built-in Function} {} allow_noninteger_range_as_index (@var{new_val}, \"local\")\n\
705 Query or set the internal variable that controls whether non-integer\n\ 705 Query or set the internal variable that controls whether non-integer\n\
706 ranges are allowed as indices. This might be useful for @sc{matlab}\n\ 706 ranges are allowed as indices.\n\
707 compatibility; however, it is still not entirely compatible because\n\ 707 \n\
708 @sc{matlab} treats the range expression differently in different contexts.\n\ 708 This might be useful for @sc{matlab} compatibility; however, it is still not\n\
709 entirely compatible because @sc{matlab} treats the range expression\n\
710 differently in different contexts.\n\
709 \n\ 711 \n\
710 When called from inside a function with the @qcode{\"local\"} option, the\n\ 712 When called from inside a function with the @qcode{\"local\"} option, the\n\
711 variable is changed locally for the function and any subroutines it calls. \n\ 713 variable is changed locally for the function and any subroutines it calls.\n\
712 The original variable value is restored when exiting the function.\n\ 714 The original variable value is restored when exiting the function.\n\
713 @end deftypefn") 715 @end deftypefn")
714 { 716 {
715 static bool warned = false; 717 static bool warned = false;
716 if (! warned) 718 if (! warned)