comparison libinterp/corefcn/spparms.cc @ 20207:4f45eaf83908 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 4197fc428c7d
children ba2b07c13913
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
42 @deftypefnx {Built-in Function} { } spparms (@var{vals})\n\ 42 @deftypefnx {Built-in Function} { } spparms (@var{vals})\n\
43 @deftypefnx {Built-in Function} { } spparms (\"default\")\n\ 43 @deftypefnx {Built-in Function} { } spparms (\"default\")\n\
44 @deftypefnx {Built-in Function} { } spparms (\"tight\")\n\ 44 @deftypefnx {Built-in Function} { } spparms (\"tight\")\n\
45 @deftypefnx {Built-in Function} { } spparms (@var{key}, @var{val})\n\ 45 @deftypefnx {Built-in Function} { } spparms (@var{key}, @var{val})\n\
46 Query or set the parameters used by the sparse solvers and factorization\n\ 46 Query or set the parameters used by the sparse solvers and factorization\n\
47 functions. The first four calls above get information about the current\n\ 47 functions.\n\
48 settings, while the others change the current settings. The parameters are\n\ 48 \n\
49 stored as pairs of keys and values, where the values are all floats and the\n\ 49 The first four calls above get information about the current settings, while\n\
50 keys are one of the following strings:\n\ 50 the others change the current settings. The parameters are stored as pairs\n\
51 of keys and values, where the values are all floats and the keys are one of\n\
52 the following strings:\n\
51 \n\ 53 \n\
52 @table @samp\n\ 54 @table @samp\n\
53 @item spumoni\n\ 55 @item spumoni\n\
54 Printing level of debugging information of the solvers (default 0)\n\ 56 Printing level of debugging information of the solvers (default 0)\n\
55 \n\ 57 \n\