Mercurial > octave-antonio

comparison libinterp/octave-value/ov-base.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
1682 @deftypefn {Built-in Function} {@var{val} =} sparse_auto_mutate ()\n\ 1682 @deftypefn {Built-in Function} {@var{val} =} sparse_auto_mutate ()\n\
1683 @deftypefnx {Built-in Function} {@var{old_val} =} sparse_auto_mutate (@var{new_val})\n\ 1683 @deftypefnx {Built-in Function} {@var{old_val} =} sparse_auto_mutate (@var{new_val})\n\
1684 @deftypefnx {Built-in Function} {} sparse_auto_mutate (@var{new_val}, \"local\")\n\ 1684 @deftypefnx {Built-in Function} {} sparse_auto_mutate (@var{new_val}, \"local\")\n\
1685 Query or set the internal variable that controls whether Octave will\n\ 1685 Query or set the internal variable that controls whether Octave will\n\
1686 automatically mutate sparse matrices to full matrices to save memory.\n\ 1686 automatically mutate sparse matrices to full matrices to save memory.\n\
1687 \n\
1687 For example:\n\ 1688 For example:\n\
1688 \n\ 1689 \n\
1689 @example\n\ 1690 @example\n\
1690 @group\n\ 1691 @group\n\
1691 s = speye (3);\n\ 1692 s = speye (3);\n\
1699 @result{} matrix\n\ 1700 @result{} matrix\n\
1700 @end group\n\ 1701 @end group\n\
1701 @end example\n\ 1702 @end example\n\
1702 \n\ 1703 \n\
1703 When called from inside a function with the @qcode{\"local\"} option, the\n\ 1704 When called from inside a function with the @qcode{\"local\"} option, the\n\
1704 variable is changed locally for the function and any subroutines it calls. \n\ 1705 variable is changed locally for the function and any subroutines it calls.\n\
1705 The original variable value is restored when exiting the function.\n\ 1706 The original variable value is restored when exiting the function.\n\
1706 @end deftypefn") 1707 @end deftypefn")
1707 { 1708 {
1708 return SET_INTERNAL_VARIABLE (sparse_auto_mutate); 1709 return SET_INTERNAL_VARIABLE (sparse_auto_mutate);
1709 } 1710 }