# HG changeset patch # User Rik # Date 1430715162 25200 # Node ID 075a5e2e1ba53478938254ff92cfb1aa7ec196cc # Parent 2645f9ef8c88528cc0fec18a43670086f9517211 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. diff -r 2645f9ef8c88 -r 075a5e2e1ba5 build-aux/mk-opts.pl --- a/build-aux/mk-opts.pl Sun May 03 17:00:11 2015 -0700 +++ b/build-aux/mk-opts.pl Sun May 03 21:52:42 2015 -0700 @@ -232,10 +232,13 @@ if (not defined $DOC_STRING) { $DOC_STRING = "Query or set options for the function \@code{$FCN_NAME}.\\n\\ +\\n\\ When called with no arguments, the names of all available options and\\n\\ their current values are displayed.\\n\\ -Given one argument, return the value of the corresponding option.\\n\\ -When called with two arguments, \@code{$OPT_FCN_NAME} set the option\\n\\ +\\n\\ +Given one argument, return the value of the option \@var{opt}.\\n\\ +\\n\\ +When called with two arguments, \@code{$OPT_FCN_NAME} sets the option\\n\\ \@var{opt} to value \@var{val}."; } } diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/__magick_read__.cc --- a/libinterp/dldfcn/__magick_read__.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/__magick_read__.cc Sun May 03 21:52:42 2015 -0700 @@ -724,8 +724,8 @@ @deftypefn {Loadable Function} {[@var{img}, @var{map}, @var{alpha}] =} __magick_read__ (@var{fname}, @var{options})\n\ Read image with GraphicsMagick or ImageMagick.\n\ \n\ -This is a private internal function not intended for direct use. Instead\n\ -use @code{imread}.\n\ +This is a private internal function not intended for direct use.\n\ +Use @code{imread} instead.\n\ \n\ @seealso{imfinfo, imformats, imread, imwrite}\n\ @end deftypefn") @@ -1388,8 +1388,8 @@ @deftypefn {Loadable Function} {} __magick_write__ (@var{fname}, @var{fmt}, @var{img}, @var{map}, @var{options})\n\ Write image with GraphicsMagick or ImageMagick.\n\ \n\ -This is a private internal function not intended for direct use. Instead\n\ -use @code{imwrite}.\n\ +This is a private internal function not intended for direct use.\n\ +Use @code{imwrite} instead.\n\ \n\ @seealso{imfinfo, imformats, imread, imwrite}\n\ @end deftypefn") @@ -1789,8 +1789,8 @@ @deftypefn {Loadable Function} {} __magick_finfo__ (@var{fname})\n\ Read image information with GraphicsMagick or ImageMagick.\n\ \n\ -This is a private internal function not intended for direct use. Instead\n\ -use @code{imfinfo}.\n\ +This is a private internal function not intended for direct use.\n\ +Use @code{imfinfo} instead.\n\ \n\ @seealso{imfinfo, imformats, imread, imwrite}\n\ @end deftypefn") diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/amd.cc --- a/libinterp/dldfcn/amd.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/amd.cc Sun May 03 21:52:42 2015 -0700 @@ -55,22 +55,23 @@ @deftypefn {Loadable Function} {@var{p} =} amd (@var{S})\n\ @deftypefnx {Loadable Function} {@var{p} =} amd (@var{S}, @var{opts})\n\ \n\ -Return the approximate minimum degree permutation of a matrix. This\n\ -permutation such that the Cholesky@tie{}factorization of @code{@var{S}\n\ -(@var{p}, @var{p})} tends to be sparser than the Cholesky@tie{}factorization\n\ -of @var{S} itself. @code{amd} is typically faster than @code{symamd} but\n\ -serves a similar purpose.\n\ +Return the approximate minimum degree permutation of a matrix.\n\ \n\ -The optional parameter @var{opts} is a structure that controls the\n\ -behavior of @code{amd}. The fields of the structure are\n\ +This is a permutation such that the Cholesky@tie{}factorization of\n\ +@code{@var{S} (@var{p}, @var{p})} tends to be sparser than the\n\ +Cholesky@tie{}factorization of @var{S} itself. @code{amd} is typically\n\ +faster than @code{symamd} but serves a similar purpose.\n\ +\n\ +The optional parameter @var{opts} is a structure that controls the behavior\n\ +of @code{amd}. The fields of the structure are\n\ \n\ @table @asis\n\ @item @var{opts}.dense\n\ Determines what @code{amd} considers to be a dense row or column of the\n\ input matrix. Rows or columns with more than @code{max (16, (dense *\n\ sqrt (@var{n})))} entries, where @var{n} is the order of the matrix @var{S},\n\ -are ignored by @code{amd} during the calculation of the permutation\n\ -The value of dense must be a positive scalar and its default value is 10.0\n\ +are ignored by @code{amd} during the calculation of the permutation.\n\ +The value of dense must be a positive scalar and the default value is 10.0\n\ \n\ @item @var{opts}.aggressive\n\ If this value is a nonzero scalar, then @code{amd} performs aggressive\n\ @@ -78,8 +79,8 @@ @end table\n\ \n\ The author of the code itself is Timothy A. Davis\n\ -@email{davis@@cise.ufl.edu}, University of Florida (see\n\ -@url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ +@email{davis@@cise.ufl.edu}, University of Florida\n\ +(see @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ @seealso{symamd, colamd}\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/audiodevinfo.cc --- a/libinterp/dldfcn/audiodevinfo.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/audiodevinfo.cc Sun May 03 21:52:42 2015 -0700 @@ -77,25 +77,28 @@ \n\ @deftypefnx {Loadable Function} {@var{supports} =} audiodevinfo (@var{io}, @var{id}, @var{rate}, @var{bits}, @var{chans})\n\ \n\ -Return a structure with fields \"input\" and \"output\".\n\ -The value of each field is a structure array with fields\n\ -\"Name\", @nospell{\"DriverVersion\"} and \"ID\" describing an audio device.\n\ +Return a structure describing the available audio input and output devices.\n\ +\n\ +The @var{devinfo} structure has two fields @qcode{\"input\"} and\n\ +@qcode{\"output\"}. The value of each field is a structure array with fields\n\ +@qcode{\"Name\"}, @nospell{\"DriverVersion\"} and @qcode{\"ID\"} describing\n\ +an audio device.\n\ \n\ If the optional argument @var{io} is 1, return information about input\n\ devices only. If it is 0, return information about output devices only.\n\ \n\ If the optional argument @var{id} is provided, return information about\n\ -corresponding device.\n\ +the corresponding device.\n\ \n\ If the optional argument @var{name} is provided, return the id of the\n\ named device.\n\ \n\ -Given a sampling rate, bits per sample, and number of channels for\n\ -an input or output device, return the ID of the first device that\n\ -supports playback or recording using the specified parameters.\n\ +Given a sampling rate, bits per sample, and number of channels for an input\n\ +or output device, return the ID of the first device that supports playback\n\ +or recording using the specified parameters.\n\ \n\ -If also given a device ID, return true if the device supports playback\n\ -or recording using those parameters.\n\ +If also given a device ID, return true if the device supports playback or\n\ +recording using those parameters.\n\ @end deftypefn") { octave_value retval; diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/audioread.cc --- a/libinterp/dldfcn/audioread.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/audioread.cc Sun May 03 21:52:42 2015 -0700 @@ -56,20 +56,18 @@ \n\ @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{datatype})\n\ @deftypefnx {Loadable Function} {[@var{y}, @var{fs}] =} audioread (@var{filename}, @var{samples}, @var{datatype})\n\ -Read the audio file @var{filename} and return the audio data and sampling\n\ -rate. The audio data is stored as matrix with rows corresponding\n\ -to audio frames and columns corresponding to channels.\n\ +Read the audio file @var{filename} and return the audio data @var{y} and\n\ +sampling rate @var{fs}.\n\ +\n\ +The audio data is stored as matrix with rows corresponding to audio frames\n\ +and columns corresponding to channels.\n\ \n\ The optional two-element vector argument @var{samples} specifies starting\n\ and ending frames.\n\ \n\ The optional argument @var{datatype} specifies the datatype to return.\n\ -If it is @qcode{\"native\"}, then the type of data depends on how the\n\ -data is stored in the audio file.\n\ -\n\ -Read a file and return a specified range of frames in an array of specified\n\ -type.\n\ -\n\ +If it is @qcode{\"native\"}, then the type of data depends on how the data\n\ +is stored in the audio file.\n\ @end deftypefn") { octave_value_list retval; @@ -258,10 +256,10 @@ @deftypefn {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs})\n\ @deftypefnx {Loadable Function} {} audiowrite (@var{filename}, @var{y}, @var{fs}, @var{name}, @var{value}, @dots{})\n\ \n\ -Write audio data from the matrix @var{y} to @var{filename} with the file\n\ -format determined by the file extension.\n\ +Write audio data from the matrix @var{y} to @var{filename} at sampling rate\n\ +@var{fs} with the file format determined by the file extension.\n\ \n\ -Additional name and value argument pairs may be used to specify the\n\ +Additional name/value argument pairs may be used to specify the\n\ following options:\n\ \n\ @table @samp\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/ccolamd.cc --- a/libinterp/dldfcn/ccolamd.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/ccolamd.cc Sun May 03 21:52:42 2015 -0700 @@ -59,16 +59,16 @@ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} ccolamd (@dots{})\n\ \n\ Constrained column approximate minimum degree permutation.\n\ +\n\ @code{@var{p} = ccolamd (@var{S})} returns the column approximate minimum\n\ degree permutation vector for the sparse matrix @var{S}. For a non-symmetric\n\ -matrix\n\ -@var{S},\n\ -@code{@var{S}(:, @var{p})} tends to have sparser LU@tie{}factors than\n\ -@var{S}. @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))} also\n\ -tends to be sparser than @code{chol (@var{S}' * @var{S})}. @code{@var{p} =\n\ -ccolamd (@var{S}, 1)} optimizes the ordering for @code{lu (@var{S}(:,\n\ -@var{p}))}. The ordering is followed by a column elimination tree\n\ -post-ordering.\n\ +matrix @var{S}, @code{@var{S}(:, @var{p})} tends to have sparser\n\ +LU@tie{}factors than @var{S}.\n\ +@code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))} also tends to be\n\ +sparser than @code{chol (@var{S}' * @var{S})}.\n\ +@code{@var{p} = ccolamd (@var{S}, 1)} optimizes the ordering for\n\ +@code{lu (@var{S}(:, @var{p}))}. The ordering is followed by a column\n\ +elimination tree post-ordering.\n\ \n\ @var{knobs} is an optional 1-element to 5-element input vector, with a\n\ default value of @code{[0 10 10 1 0]} if not present or empty. Entries not\n\ @@ -77,16 +77,17 @@ @table @code\n\ @item @var{knobs}(1)\n\ if nonzero, the ordering is optimized for @code{lu (S(:, p))}. It will be a\n\ -poor ordering for @code{chol (@var{S}(:, @var{p})' * @var{S}(:,\n\ -@var{p}))}. This is the most important knob for ccolamd.\n\ +poor ordering for @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}.\n\ +This is the most important knob for ccolamd.\n\ \n\ @item @var{knobs}(2)\n\ -if @var{S} is m-by-n, rows with more than @code{max (16, @var{knobs}(2) *\n\ -sqrt (n))} entries are ignored.\n\ +if @var{S} is m-by-n, rows with more than\n\ +@code{max (16, @var{knobs}(2) * sqrt (n))} entries are ignored.\n\ \n\ @item @var{knobs}(3)\n\ -columns with more than @code{max (16, @var{knobs}(3) * sqrt (min (@var{m},\n\ -@var{n})))} entries are ignored and ordered last in the output permutation\n\ +columns with more than\n\ +@code{max (16, @var{knobs}(3) * sqrt (min (@var{m}, @var{n})))} entries are\n\ +ignored and ordered last in the output permutation\n\ (subject to the cmember constraints).\n\ \n\ @item @var{knobs}(4)\n\ @@ -344,17 +345,18 @@ @deftypefnx {Loadable Function} {@var{p} =} csymamd (@var{S}, @var{knobs}, @var{cmember})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} csymamd (@dots{})\n\ \n\ -For a symmetric positive definite matrix @var{S}, returns the permutation\n\ +For a symmetric positive definite matrix @var{S}, return the permutation\n\ vector @var{p} such that @code{@var{S}(@var{p},@var{p})} tends to have a\n\ -sparser Cholesky@tie{}factor than @var{S}. Sometimes @code{csymamd} works\n\ -well for symmetric indefinite matrices too. The matrix @var{S} is assumed\n\ -to be symmetric; only the strictly lower triangular part is referenced.\n\ -@var{S} must be square. The ordering is followed by an elimination tree\n\ -post-ordering.\n\ +sparser Cholesky@tie{}factor than @var{S}.\n\ +\n\ +Sometimes @code{csymamd} works well for symmetric indefinite matrices too. \n\ +The matrix @var{S} is assumed to be symmetric; only the strictly lower\n\ +triangular part is referenced. @var{S} must be square. The ordering is\n\ +followed by an elimination tree post-ordering.\n\ \n\ @var{knobs} is an optional 1-element to 3-element input vector, with a\n\ -default value of @code{[10 1 0]} if present or empty. Entries not\n\ -present are set to their defaults.\n\ +default value of @code{[10 1 0]}. Entries not present are set to their\n\ +defaults.\n\ \n\ @table @code\n\ @item @var{knobs}(1)\n\ @@ -377,8 +379,9 @@ by all rows/columns in set 2, and so on. @code{@var{cmember} = ones (1,n)}\n\ if not present or empty. @code{csymamd (@var{S},[],1:n)} returns @code{1:n}.\n\ \n\ -@code{@var{p} = csymamd (@var{S})} is about the same as @code{@var{p} =\n\ -symamd (@var{S})}. @var{knobs} and its default values differ.\n\ +@code{@var{p} = csymamd (@var{S})} is about the same as\n\ +@code{@var{p} = symamd (@var{S})}. @var{knobs} and its default values\n\ +differ.\n\ \n\ @code{@var{stats}(4:7)} provide information if CCOLAMD was able to\n\ continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/chol.cc --- a/libinterp/dldfcn/chol.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/chol.cc Sun May 03 21:52:42 2015 -0700 @@ -70,7 +70,9 @@ @deftypefnx {Loadable Function} {[@var{L}, @dots{}] =} chol (@dots{}, \"upper\")\n\ @cindex Cholesky factorization\n\ Compute the Cholesky@tie{}factor, @var{R}, of the symmetric positive definite\n\ -matrix @var{A}, where\n\ +matrix @var{A}.\n\ +\n\ +The Cholesky@tie{}factor is defined by\n\ @tex\n\ $ R^T R = A $.\n\ @end tex\n\ @@ -89,8 +91,8 @@ gives the factorization, and @var{p} will have a positive value otherwise.\n\ \n\ If called with 3 outputs then a sparsity preserving row/column permutation\n\ -is applied to @var{A} prior to the factorization. That is @var{R}\n\ -is the factorization of @code{@var{A}(@var{Q},@var{Q})} such that\n\ +is applied to @var{A} prior to the factorization. That is @var{R} is the\n\ +factorization of @code{@var{A}(@var{Q},@var{Q})} such that\n\ @tex\n\ $ R^T R = Q^T A Q$.\n\ @end tex\n\ @@ -390,8 +392,8 @@ DEFUN_DLD (cholinv, args, , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} cholinv (@var{A})\n\ -Use the Cholesky@tie{}factorization to compute the inverse of the\n\ -symmetric positive definite matrix @var{A}.\n\ +Compute the inverse of the symmetric positive definite matrix @var{A} using\n\ +the Cholesky@tie{}factorization.\n\ @seealso{chol, chol2inv, inv}\n\ @end deftypefn") { @@ -538,10 +540,11 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} chol2inv (@var{U})\n\ Invert a symmetric, positive definite square matrix from its Cholesky\n\ -decomposition, @var{U}. Note that @var{U} should be an upper-triangular\n\ -matrix with positive diagonal elements. @code{chol2inv (@var{U})}\n\ -provides @code{inv (@var{U}'*@var{U})} but it is much faster than\n\ -using @code{inv}.\n\ +decomposition, @var{U}.\n\ +\n\ +Note that @var{U} should be an upper-triangular matrix with positive\n\ +diagonal elements. @code{chol2inv (@var{U})} provides\n\ +@code{inv (@var{U}'*@var{U})} but it is much faster than using @code{inv}.\n\ @seealso{chol, cholinv, inv}\n\ @end deftypefn") { @@ -629,9 +632,10 @@ DEFUN_DLD (cholupdate, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{R1}, @var{info}] =} cholupdate (@var{R}, @var{u}, @var{op})\n\ -Update or downdate a Cholesky@tie{}factorization. Given an upper triangular\n\ -matrix @var{R} and a column vector @var{u}, attempt to determine another\n\ -upper triangular matrix @var{R1} such that\n\ +Update or downdate a Cholesky@tie{}factorization.\n\ +\n\ +Given an upper triangular matrix @var{R} and a column vector @var{u},\n\ +attempt to determine another upper triangular matrix @var{R1} such that\n\ \n\ @itemize @bullet\n\ @item\n\ @@ -844,6 +848,7 @@ triangular, return the Cholesky@tie{}factorization of\n\ @var{A1}, where @w{A1(p,p) = A}, @w{A1(:,j) = A1(j,:)' = u} and\n\ @w{p = [1:j-1,j+1:n+1]}. @w{u(j)} should be positive.\n\ +\n\ On return, @var{info} is set to\n\ \n\ @itemize\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/colamd.cc --- a/libinterp/dldfcn/colamd.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/colamd.cc Sun May 03 21:52:42 2015 -0700 @@ -216,7 +216,8 @@ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} colamd (@var{S})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} colamd (@var{S}, @var{knobs})\n\ \n\ -Column approximate minimum degree permutation.\n\ +Compute the column approximate minimum degree permutation.\n\ +\n\ @code{@var{p} = colamd (@var{S})} returns the column approximate minimum\n\ degree permutation vector for the sparse matrix @var{S}. For a\n\ non-symmetric matrix @var{S}, @code{@var{S}(:,@var{p})} tends to have\n\ @@ -258,7 +259,7 @@ @sc{colamd} is thus a simple way to check a sparse matrix to see if it's\n\ valid.\n\ \n\ -@code{@var{stats}(4:7)} provide information if COLAMD was able to\n\ +@code{@var{stats}(4:7)} provide information if @sc{colamd} was able to\n\ continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if\n\ invalid. @code{@var{stats}(5)} is the rightmost column index that is\n\ unsorted or contains duplicate entries, or zero if no such column exists.\n\ @@ -458,25 +459,27 @@ \n\ For a symmetric positive definite matrix @var{S}, returns the permutation\n\ vector p such that @code{@var{S}(@var{p}, @var{p})} tends to have a\n\ -sparser Cholesky@tie{}factor than @var{S}. Sometimes @code{symamd} works\n\ -well for symmetric indefinite matrices too. The matrix @var{S} is assumed\n\ -to be symmetric; only the strictly lower triangular part is referenced.\n\ -@var{S} must be square.\n\ +sparser Cholesky@tie{}factor than @var{S}.\n\ +\n\ +Sometimes @code{symamd} works well for symmetric indefinite matrices too. \n\ +The matrix @var{S} is assumed to be symmetric; only the strictly lower\n\ +triangular part is referenced. @var{S} must be square.\n\ \n\ @var{knobs} is an optional one- to two-element input vector. If @var{S} is\n\ n-by-n, then rows and columns with more than\n\ @code{max (16,@var{knobs}(1)*sqrt(n))} entries are removed prior to ordering,\n\ and ordered last in the output permutation @var{p}. No rows/columns are\n\ removed if @code{@var{knobs}(1) < 0}. If @code{@var{knobs} (2)} is nonzero,\n\ -@code{stats} and @var{knobs} are printed. The default is @code{@var{knobs}\n\ -= [10 0]}. Note that @var{knobs} differs from earlier versions of symamd.\n\ +@code{stats} and @var{knobs} are printed. The default is\n\ +@code{@var{knobs} = [10 0]}. Note that @var{knobs} differs from earlier\n\ +versions of @code{symamd}.\n\ \n\ @var{stats} is an optional 20-element output vector that provides data\n\ about the ordering and the validity of the input matrix @var{S}. Ordering\n\ -statistics are in @code{@var{stats}(1:3)}. @code{@var{stats}(1) =\n\ -@var{stats}(2)} is the number of dense or empty rows and columns\n\ -ignored by SYMAMD and @code{@var{stats}(3)} is the number of garbage\n\ -collections performed on the internal data structure used by SYMAMD\n\ +statistics are in @code{@var{stats}(1:3)}.\n\ +@code{@var{stats}(1) = @var{stats}(2)} is the number of dense or empty rows\n\ +and columns ignored by SYMAMD and @code{@var{stats}(3)} is the number of\n\ +garbage collections performed on the internal data structure used by SYMAMD\n\ (roughly of size @code{8.4 * nnz (tril (@var{S}, -1)) + 9 * @var{n}}\n\ integers).\n\ \n\ @@ -648,9 +651,10 @@ @deftypefnx {Loadable Function} {@var{p} =} etree (@var{S}, @var{typ})\n\ @deftypefnx {Loadable Function} {[@var{p}, @var{q}] =} etree (@var{S}, @var{typ})\n\ \n\ -Return the elimination tree for the matrix @var{S}. By default @var{S}\n\ -is assumed to be symmetric and the symmetric elimination tree is\n\ -returned. The argument @var{typ} controls whether a symmetric or\n\ +Return the elimination tree for the matrix @var{S}.\n\ +\n\ +By default @var{S} is assumed to be symmetric and the symmetric elimination\n\ +tree is returned. The argument @var{typ} controls whether a symmetric or\n\ column elimination tree is returned. Valid values of @var{typ} are\n\ @qcode{\"sym\"} or @qcode{\"col\"}, for symmetric or column elimination tree\n\ respectively.\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/convhulln.cc --- a/libinterp/dldfcn/convhulln.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/convhulln.cc Sun May 03 21:52:42 2015 -0700 @@ -77,8 +77,11 @@ @deftypefn {Loadable Function} {@var{h} =} convhulln (@var{pts})\n\ @deftypefnx {Loadable Function} {@var{h} =} convhulln (@var{pts}, @var{options})\n\ @deftypefnx {Loadable Function} {[@var{h}, @var{v}] =} convhulln (@dots{})\n\ -Compute the convex hull of the set of points @var{pts} which is a matrix\n\ -of size [n, dim] containing n points in a space of dimension dim.\n\ +Compute the convex hull of the set of points @var{pts}.\n\ +\n\ +@var{pts} is a matrix of size [n, dim] containing n points in a space of\n\ +dimension dim.\n\ +\n\ The hull @var{h} is an index vector into the set of points and specifies\n\ which points form the enclosing hull.\n\ \n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/dmperm.cc --- a/libinterp/dldfcn/dmperm.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/dmperm.cc Sun May 03 21:52:42 2015 -0700 @@ -194,9 +194,10 @@ @deftypefn {Loadable Function} {@var{p} =} sprank (@var{S})\n\ @cindex structural rank\n\ \n\ -Calculate the structural rank of the sparse matrix @var{S}. Note that\n\ -only the structure of the matrix is used in this calculation based on\n\ -a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\ +Calculate the structural rank of the sparse matrix @var{S}.\n\ +\n\ +Note that only the structure of the matrix is used in this calculation based\n\ +on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\ such the numerical rank of the matrix @var{S} is bounded by\n\ @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors\n\ @code{sprank (@var{S}) == rank (@var{S})}.\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/fftw.cc --- a/libinterp/dldfcn/fftw.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/fftw.cc Sun May 03 21:52:42 2015 -0700 @@ -43,12 +43,14 @@ @deftypefnx {Loadable Function} {} fftw (\"threads\", @var{nthreads})\n\ @deftypefnx {Loadable Function} {@var{nthreads} =} fftw (\"threads\")\n\ \n\ -Manage @sc{fftw} wisdom data. Wisdom data can be used to significantly\n\ -accelerate the calculation of the FFTs, but implies an initial cost\n\ -in its calculation. When the @sc{fftw} libraries are initialized, they read\n\ -a system wide wisdom file (typically in @file{/etc/fftw/wisdom}), allowing\n\ -wisdom to be shared between applications other than Octave. Alternatively,\n\ -the @code{fftw} function can be used to import wisdom. For example,\n\ +Manage @sc{fftw} wisdom data.\n\ +\n\ +Wisdom data can be used to significantly accelerate the calculation of the\n\ +FFTs, but implies an initial cost in its calculation. When the @sc{fftw}\n\ +libraries are initialized, they read a system wide wisdom file (typically in\n\ +@file{/etc/fftw/wisdom}), allowing wisdom to be shared between applications\n\ +other than Octave. Alternatively, the @code{fftw} function can be used to\n\ +import wisdom. For example,\n\ \n\ @example\n\ @var{wisdom} = fftw (\"dwisdom\")\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/qr.cc --- a/libinterp/dldfcn/qr.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/qr.cc Sun May 03 21:52:42 2015 -0700 @@ -80,7 +80,9 @@ @deftypefnx {Loadable Function} {[@var{C}, @var{R}] =} qr (@var{A}, @var{B}, '0')\n\ @cindex QR factorization\n\ Compute the QR@tie{}factorization of @var{A}, using standard @sc{lapack}\n\ -subroutines. For example, given the matrix @code{@var{A} = [1, 2; 3, 4]},\n\ +subroutines.\n\ +\n\ +For example, given the matrix @code{@var{A} = [1, 2; 3, 4]},\n\ \n\ @example\n\ [@var{Q}, @var{R}] = qr (@var{A})\n\ @@ -124,7 +126,7 @@ @ifnottex\n\ @var{A}\n\ @end ifnottex\n\ - is a tall, thin matrix). The QR@tie{}factorization is\n\ +is a tall, thin matrix). The QR@tie{}factorization is\n\ @tex\n\ $QR = A$ where $Q$ is an orthogonal matrix and $R$ is upper triangular.\n\ @end tex\n\ @@ -140,8 +142,8 @@ If the matrix @var{A} is full, the permuted QR@tie{}factorization\n\ @code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} forms the\n\ QR@tie{}factorization such that the diagonal entries of @var{R} are\n\ -decreasing in magnitude order. For example, given the matrix @code{a = [1,\n\ -2; 3, 4]},\n\ +decreasing in magnitude order. For example, given the matrix\n\ +@code{a = [1, 2; 3, 4]},\n\ \n\ @example\n\ [@var{Q}, @var{R}, @var{P}] = qr (@var{A})\n\ @@ -169,15 +171,15 @@ @end group\n\ @end example\n\ \n\ -The permuted @code{qr} factorization @code{[@var{Q}, @var{R}, @var{P}] = qr\n\ -(@var{A})} factorization allows the construction of an orthogonal basis of\n\ -@code{span (A)}.\n\ +The permuted @code{qr} factorization\n\ +@code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} factorization allows the\n\ +construction of an orthogonal basis of @code{span (A)}.\n\ \n\ If the matrix @var{A} is sparse, then compute the sparse\n\ QR@tie{}factorization of @var{A}, using @sc{CSparse}. As the matrix @var{Q}\n\ is in general a full matrix, this function returns the @var{Q}-less\n\ -factorization @var{R} of @var{A}, such that @code{@var{R} = chol (@var{A}' *\n\ -@var{A})}.\n\ +factorization @var{R} of @var{A}, such that\n\ +@code{@var{R} = chol (@var{A}' * @var{A})}.\n\ \n\ If the final argument is the scalar @code{0} and the number of rows is\n\ larger than the number of columns, then an economy factorization is\n\ @@ -763,15 +765,15 @@ @deftypefn {Loadable Function} {[@var{Q1}, @var{R1}] =} qrupdate (@var{Q}, @var{R}, @var{u}, @var{v})\n\ Given a QR@tie{}factorization of a real or complex matrix\n\ @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\ -@var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization\n\ -of @w{@var{A} + @var{u}*@var{v}'}, where @var{u} and @var{v} are\n\ -column vectors (rank-1 update) or matrices with equal number of columns\n\ +@var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\ +@w{@var{A} + @var{u}*@var{v}'}, where @var{u} and @var{v} are column vectors\n\ +(rank-1 update) or matrices with equal number of columns\n\ (rank-k update). Notice that the latter case is done as a sequence of rank-1\n\ updates; thus, for k large enough, it will be both faster and more accurate\n\ to recompute the factorization from scratch.\n\ \n\ -The QR@tie{}factorization supplied may be either full\n\ -(Q is square) or economized (R is square).\n\ +The QR@tie{}factorization supplied may be either full (Q is square) or\n\ +economized (R is square).\n\ \n\ @seealso{qr, qrinsert, qrdelete, qrshift}\n\ @end deftypefn") @@ -944,24 +946,21 @@ Given a QR@tie{}factorization of a real or complex matrix\n\ @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\ @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\ -@w{[A(:,1:j-1) x A(:,j:n)]}, where @var{u} is a column vector to be\n\ -inserted into @var{A} (if @var{orient} is @qcode{\"col\"}), or the\n\ -QR@tie{}factorization of @w{[A(1:j-1,:);x;A(:,j:n)]}, where @var{x}\n\ -is a row vector to be inserted into @var{A} (if @var{orient} is\n\ -@qcode{\"row\"}).\n\ +@w{[A(:,1:j-1) x A(:,j:n)]}, where @var{u} is a column vector to be inserted\n\ +into @var{A} (if @var{orient} is @qcode{\"col\"}), or the\n\ +QR@tie{}factorization of @w{[A(1:j-1,:);x;A(:,j:n)]}, where @var{x} is a row\n\ +vector to be inserted into @var{A} (if @var{orient} is @qcode{\"row\"}).\n\ \n\ -The default value of @var{orient} is @qcode{\"col\"}.\n\ -If @var{orient} is @qcode{\"col\"},\n\ -@var{u} may be a matrix and @var{j} an index vector\n\ +The default value of @var{orient} is @qcode{\"col\"}. If @var{orient} is\n\ +@qcode{\"col\"}, @var{u} may be a matrix and @var{j} an index vector\n\ resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\ @w{B(:,@var{j})} gives @var{u} and @w{B(:,@var{j}) = []} gives @var{A}.\n\ Notice that the latter case is done as a sequence of k insertions;\n\ thus, for k large enough, it will be both faster and more accurate to\n\ recompute the factorization from scratch.\n\ \n\ -If @var{orient} is @qcode{\"col\"},\n\ -the QR@tie{}factorization supplied may be either full\n\ -(Q is square) or economized (R is square).\n\ +If @var{orient} is @qcode{\"col\"}, the QR@tie{}factorization supplied may\n\ +be either full (Q is square) or economized (R is square).\n\ \n\ If @var{orient} is @qcode{\"row\"}, full factorization is needed.\n\ @seealso{qr, qrupdate, qrdelete, qrshift}\n\ @@ -1173,17 +1172,14 @@ \n\ The default value of @var{orient} is @qcode{\"col\"}.\n\ \n\ -If @var{orient} is @qcode{\"col\"},\n\ -@var{j} may be an index vector\n\ +If @var{orient} is @qcode{\"col\"}, @var{j} may be an index vector\n\ resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\ -@w{A(:,@var{j}) = []} gives @var{B}.\n\ -Notice that the latter case is done as a sequence of k deletions;\n\ -thus, for k large enough, it will be both faster and more accurate to\n\ -recompute the factorization from scratch.\n\ +@w{A(:,@var{j}) = []} gives @var{B}. Notice that the latter case is done as\n\ +a sequence of k deletions; thus, for k large enough, it will be both faster\n\ +and more accurate to recompute the factorization from scratch.\n\ \n\ -If @var{orient} is @qcode{\"col\"},\n\ -the QR@tie{}factorization supplied may be either full\n\ -(Q is square) or economized (R is square).\n\ +If @var{orient} is @qcode{\"col\"}, the QR@tie{}factorization supplied may\n\ +be either full (Q is square) or economized (R is square).\n\ \n\ If @var{orient} is @qcode{\"row\"}, full factorization is needed.\n\ @seealso{qr, qrupdate, qrinsert, qrshift}\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/symbfact.cc --- a/libinterp/dldfcn/symbfact.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/symbfact.cc Sun May 03 21:52:42 2015 -0700 @@ -46,7 +46,8 @@ @deftypefnx {Loadable Function} {[@dots{}] =} symbfact (@var{S}, @var{typ}, @var{mode})\n\ \n\ Perform a symbolic factorization analysis on the sparse matrix @var{S}.\n\ -Where\n\ +\n\ +The input variables are\n\ \n\ @table @var\n\ @item S\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/dldfcn/symrcm.cc --- a/libinterp/dldfcn/symrcm.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/dldfcn/symrcm.cc Sun May 03 21:52:42 2015 -0700 @@ -415,15 +415,16 @@ "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{p} =} symrcm (@var{S})\n\ Return the symmetric reverse @nospell{Cuthill-McKee} permutation of @var{S}.\n\ +\n\ @var{p} is a permutation vector such that\n\ -@code{@var{S}(@var{p}, @var{p})} tends to have its diagonal elements\n\ -closer to the diagonal than @var{S}. This is a good preordering for LU\n\ -or Cholesky@tie{}factorization of matrices that come from ``long, skinny''\n\ +@code{@var{S}(@var{p}, @var{p})} tends to have its diagonal elements closer\n\ +to the diagonal than @var{S}. This is a good preordering for LU or\n\ +Cholesky@tie{}factorization of matrices that come from ``long, skinny''\n\ problems. It works for both symmetric and asymmetric @var{S}.\n\ \n\ -The algorithm represents a heuristic approach to the NP-complete\n\ -bandwidth minimization problem. The implementation is based in the\n\ -descriptions found in\n\ +The algorithm represents a heuristic approach to the NP-complete bandwidth\n\ +minimization problem. The implementation is based in the descriptions found\n\ +in\n\ \n\ @nospell{E. Cuthill, J. McKee}. @cite{Reducing the Bandwidth of Sparse\n\ Symmetric Matrices}. Proceedings of the 24th ACM National Conference,\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-base.cc --- a/libinterp/octave-value/ov-base.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-base.cc Sun May 03 21:52:42 2015 -0700 @@ -1684,6 +1684,7 @@ @deftypefnx {Built-in Function} {} sparse_auto_mutate (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether Octave will\n\ automatically mutate sparse matrices to full matrices to save memory.\n\ +\n\ For example:\n\ \n\ @example\n\ @@ -1701,7 +1702,7 @@ @end example\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-bool-mat.cc --- a/libinterp/octave-value/ov-bool-mat.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-bool-mat.cc Sun May 03 21:52:42 2015 -0700 @@ -561,9 +561,9 @@ @deftypefn {Built-in Function} {} logical (@var{x})\n\ Convert the numeric object @var{x} to logical type.\n\ \n\ -Any nonzero values will be converted to true (1) while zero values\n\ -will be converted to false (0). The non-numeric value NaN cannot be\n\ -converted and will produce an error.\n\ +Any nonzero values will be converted to true (1) while zero values will be\n\ +converted to false (0). The non-numeric value NaN cannot be converted and\n\ +will produce an error.\n\ \n\ Compatibility Note: Octave accepts complex values as input, whereas\n\ @sc{matlab} issues an error.\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-cell.cc --- a/libinterp/octave-value/ov-cell.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-cell.cc Sun May 03 21:52:42 2015 -0700 @@ -1301,9 +1301,9 @@ Create a new cell array object.\n\ \n\ If invoked with a single scalar integer argument, return a square\n\ -@nospell{NxN} cell array. If invoked with two or more scalar\n\ -integer arguments, or a vector of integer values, return an array with\n\ -the given dimensions.\n\ +@nospell{NxN} cell array. If invoked with two or more scalar integer\n\ +arguments, or a vector of integer values, return an array with the given\n\ +dimensions.\n\ @seealso{cellstr, mat2cell, num2cell, struct2cell}\n\ @end deftypefn") { @@ -1357,8 +1357,8 @@ DEFUN (iscellstr, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} iscellstr (@var{cell})\n\ -Return true if every element of the cell array @var{cell} is a\n\ -character string.\n\ +Return true if every element of the cell array @var{cell} is a character\n\ +string.\n\ @seealso{ischar}\n\ @end deftypefn") { @@ -1380,8 +1380,8 @@ DEFUN (cellstr, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{cstr} =} cellstr (@var{strmat})\n\ -Create a new cell array object from the elements of the string\n\ -array @var{strmat}.\n\ +Create a new cell array object from the elements of the string array\n\ +@var{strmat}.\n\ \n\ Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\ spaces in a row are deleted before conversion.\n\ @@ -1420,8 +1420,9 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{c} =} struct2cell (@var{s})\n\ Create a new cell array from the objects stored in the struct object.\n\ -If @var{f} is the number of fields in the structure, the resulting\n\ -cell array will have a dimension vector corresponding to\n\ +\n\ +If @var{f} is the number of fields in the structure, the resulting cell\n\ +array will have a dimension vector corresponding to\n\ @code{[@var{f} size(@var{s})]}. For example:\n\ \n\ @example\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-class.cc --- a/libinterp/octave-value/ov-class.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-class.cc Sun May 03 21:52:42 2015 -0700 @@ -1863,10 +1863,11 @@ @deftypefn {Function File} {@var{classname} =} class (@var{obj})\n\ @deftypefnx {Function File} {} class (@var{s}, @var{id})\n\ @deftypefnx {Function File} {} class (@var{s}, @var{id}, @var{p}, @dots{})\n\ -Return the class of the object @var{obj} or create a class with\n\ -fields from structure @var{s} and name (string) @var{id}. Additional\n\ -arguments name a list of parent classes from which the new class is\n\ -derived.\n\ +Return the class of the object @var{obj}, or create a class with\n\ +fields from structure @var{s} and name (string) @var{id}.\n\ +\n\ +Additional arguments name a list of parent classes from which the new class\n\ +is derived.\n\ @seealso{typeinfo, isa}\n\ @end deftypefn") { @@ -2209,6 +2210,7 @@ @deftypefn {Built-in Function} {} superiorto (@var{class_name}, @dots{})\n\ When called from a class constructor, mark the object currently\n\ constructed as having a higher precedence than @var{class_name}.\n\ +\n\ More that one such class can be specified in a single call.\n\ This function may only be called from a class constructor.\n\ @seealso{inferiorto}\n\ @@ -2254,6 +2256,7 @@ @deftypefn {Built-in Function} {} inferiorto (@var{class_name}, @dots{})\n\ When called from a class constructor, mark the object currently\n\ constructed as having a lower precedence than @var{class_name}.\n\ +\n\ More that one such class can be specified in a single call.\n\ This function may only be called from a class constructor.\n\ @seealso{superiorto}\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-fcn-handle.cc --- a/libinterp/octave-value/ov-fcn-handle.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-fcn-handle.cc Sun May 03 21:52:42 2015 -0700 @@ -1676,7 +1676,7 @@ Return a structure containing information about the function handle\n\ @var{fcn_handle}.\n\ \n\ -The structure @var{s} always contains these 3 fields:\n\ +The structure @var{s} always contains these three fields:\n\ \n\ @table @asis\n\ @item function\n\ @@ -1811,8 +1811,8 @@ DEFUN (func2str, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} func2str (@var{fcn_handle})\n\ -Return a string containing the name of the function referenced by\n\ -the function handle @var{fcn_handle}.\n\ +Return a string containing the name of the function referenced by the\n\ +function handle @var{fcn_handle}.\n\ @seealso{str2func, functions}\n\ @end deftypefn") { @@ -1851,6 +1851,7 @@ @deftypefn {Built-in Function} {} str2func (@var{fcn_name})\n\ @deftypefnx {Built-in Function} {} str2func (@var{fcn_name}, \"global\")\n\ Return a function handle constructed from the string @var{fcn_name}.\n\ +\n\ If the optional @qcode{\"global\"} argument is passed, locally visible\n\ functions are ignored in the lookup.\n\ @seealso{func2str, inline}\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-fcn-inline.cc --- a/libinterp/octave-value/ov-fcn-inline.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-fcn-inline.cc Sun May 03 21:52:42 2015 -0700 @@ -654,17 +654,16 @@ @deftypefnx {Built-in Function} {} inline (@var{str}, @var{n})\n\ Create an inline function from the character string @var{str}.\n\ \n\ -If called with a single argument, the arguments of the generated\n\ -function are extracted from the function itself. The generated\n\ -function arguments will then be in alphabetical order. It should\n\ -be noted that i, and j are ignored as arguments due to the\n\ -ambiguity between their use as a variable or their use as an inbuilt\n\ -constant. All arguments followed by a parenthesis are considered\n\ -to be functions. If no arguments are found, a function taking a single\n\ -argument named @code{x} will be created.\n\ +If called with a single argument, the arguments of the generated function\n\ +are extracted from the function itself. The generated function arguments\n\ +will then be in alphabetical order. It should be noted that i and j are\n\ +ignored as arguments due to the ambiguity between their use as a variable or\n\ +their use as an built-in constant. All arguments followed by a parenthesis\n\ +are considered to be functions. If no arguments are found, a function\n\ +taking a single argument named @code{x} will be created.\n\ \n\ -If the second and subsequent arguments are character strings,\n\ -they are the names of the arguments of the function.\n\ +If the second and subsequent arguments are character strings, they are the\n\ +names of the arguments of the function.\n\ \n\ If the second argument is an integer @var{n}, the arguments are\n\ @qcode{\"x\"}, @qcode{\"P1\"}, @dots{}, @qcode{\"P@var{N}\"}.\n\ @@ -904,8 +903,8 @@ DEFUN (argnames, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} argnames (@var{fun})\n\ -Return a cell array of character strings containing the names of\n\ -the arguments of the inline function @var{fun}.\n\ +Return a cell array of character strings containing the names of the\n\ +arguments of the inline function @var{fun}.\n\ @seealso{inline, formula, vectorize}\n\ @end deftypefn") { @@ -951,13 +950,11 @@ DEFUN (vectorize, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} vectorize (@var{fun})\n\ -Create a vectorized version of the inline function @var{fun}\n\ -by replacing all occurrences of @code{*}, @code{/}, etc., with\n\ -@code{.*}, @code{./}, etc.\n\ +Create a vectorized version of the inline function @var{fun} by replacing\n\ +all occurrences of @code{*}, @code{/}, etc., with @code{.*}, @code{./}, etc.\n\ \n\ -This may be useful, for example, when using inline functions with\n\ -numerical integration or optimization where a vector-valued function\n\ -is expected.\n\ +This may be useful, for example, when using inline functions with numerical\n\ +integration or optimization where a vector-valued function is expected.\n\ \n\ @example\n\ @group\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-java.cc --- a/libinterp/octave-value/ov-java.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-java.cc Sun May 03 21:52:42 2015 -0700 @@ -2041,8 +2041,9 @@ DEFUN (__java_init__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} java_init ()\n\ +@deftypefn {Built-in Function} {} __java_init__ ()\n\ Internal function used @strong{only} when debugging Java interface.\n\ +\n\ Function will directly call initialize_java() to create an instance of a JVM.\n\ @end deftypefn") { @@ -2066,8 +2067,9 @@ DEFUN (__java_exit__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} java_exit ()\n\ +@deftypefn {Built-in Function} {} __java_exit__ ()\n\ Internal function used @strong{only} when debugging Java interface.\n\ +\n\ Function will directly call terminate_jvm() to destroy the current JVM\n\ instance.\n\ @end deftypefn") @@ -2088,8 +2090,8 @@ Create a Java object of class @var{classsname}, by calling the class\n\ constructor with the arguments @var{arg1}, @dots{}\n\ \n\ -The first example below creates an uninitialized object,\n\ -while the second example supplies an initial argument to the constructor.\n\ +The first example below creates an uninitialized object, while the second\n\ +example supplies an initial argument to the constructor.\n\ \n\ @example\n\ @group\n\ @@ -2148,9 +2150,10 @@ @deftypefn {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj})\n\ @deftypefnx {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj}, @var{arg1}, @dots{})\n\ Invoke the method @var{methodname} on the Java object @var{obj} with the\n\ -arguments @var{arg1}, @dots{} For static methods, @var{obj} can be a string\n\ -representing the fully qualified name of the corresponding class. The\n\ -function returns the result of the method invocation.\n\ +arguments @var{arg1}, @dots{}.\n\ +\n\ +For static methods, @var{obj} can be a string representing the fully\n\ +qualified name of the corresponding class.\n\ \n\ When @var{obj} is a regular Java object, structure-like indexing can be\n\ used as a shortcut syntax. For instance, the two following statements are\n\ @@ -2163,6 +2166,8 @@ @end group\n\ @end example\n\ \n\ +@code{javaMethod} returns the result of the method invocation.\n\ +\n\ @seealso{methods, javaObject}\n\ @end deftypefn") { @@ -2222,12 +2227,13 @@ DEFUN (__java_get__, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} __java_get__ (@var{obj}, @var{name})\n\ -Get the value of the field @var{name} of the Java object @var{obj}. For\n\ -static fields, @var{obj} can be a string representing the fully qualified\n\ +Get the value of the field @var{name} of the Java object @var{obj}.\n\ +\n\ +For static fields, @var{obj} can be a string representing the fully qualified\n\ name of the corresponding class.\n\ \n\ -When @var{obj} is a regular Java object, structure-like indexing can be\n\ -used as a shortcut syntax. For instance, the two following statements are\n\ +When @var{obj} is a regular Java object, structure-like indexing can be used\n\ +as a shortcut syntax. For instance, the two following statements are\n\ equivalent\n\ \n\ @example\n\ @@ -2286,8 +2292,10 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{obj} =} __java_set__ (@var{obj}, @var{name}, @var{val})\n\ Set the value of the field @var{name} of the Java object @var{obj} to\n\ -@var{val}. For static fields, @var{obj} can be a string representing the\n\ -fully qualified named of the corresponding Java class.\n\ +@var{val}.\n\ +\n\ +For static fields, @var{obj} can be a string representing the fully\n\ +qualified named of the corresponding Java class.\n\ \n\ When @var{obj} is a regular Java object, structure-like indexing can be\n\ used as a shortcut syntax. For instance, the two following statements are\n\ @@ -2387,10 +2395,12 @@ @deftypefnx {Built-in Function} {@var{old_val} =} java_matrix_autoconversion (@var{new_val})\n\ @deftypefnx {Built-in Function} {} java_matrix_autoconversion (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether Java arrays are\n\ -automatically converted to Octave matrices. The default value is false.\n\ +automatically converted to Octave matrices.\n\ +\n\ +The default value is false.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_unsigned_autoconversion, debug_java}\n\ @end deftypefn") @@ -2409,12 +2419,13 @@ @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_autoconversion (@var{new_val})\n\ @deftypefnx {Built-in Function} {} java_unsigned_autoconversion (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls how integer classes are\n\ -converted when @code{java_matrix_autoconversion} is enabled. When enabled,\n\ -Java arrays of class Byte or Integer are converted to matrices of class\n\ -uint8 or uint32 respectively. The default value is true.\n\ +converted when @code{java_matrix_autoconversion} is enabled.\n\ +\n\ +When enabled, Java arrays of class Byte or Integer are converted to matrices\n\ +of class uint8 or uint32 respectively. The default value is true.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_matrix_autoconversion, debug_java}\n\ @end deftypefn") @@ -2437,7 +2448,7 @@ is printed.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_matrix_autoconversion, java_unsigned_autoconversion}\n\ @end deftypefn") diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-null-mat.cc --- a/libinterp/octave-value/ov-null-mat.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-null-mat.cc Sun May 03 21:52:42 2015 -0700 @@ -97,9 +97,11 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isnull (@var{x})\n\ Return true if @var{x} is a special null matrix, string, or single quoted\n\ -string. Indexed assignment with such a value on the right-hand side should\n\ -delete array elements. This function should be used when overloading\n\ -indexed assignment for user-defined classes instead of @code{isempty}, to\n\ +string.\n\ +\n\ +Indexed assignment with such a value on the right-hand side should delete\n\ +array elements. This function should be used when overloading indexed\n\ +assignment for user-defined classes instead of @code{isempty}, to\n\ distinguish the cases:\n\ \n\ @table @asis\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-oncleanup.cc --- a/libinterp/octave-value/ov-oncleanup.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-oncleanup.cc Sun May 03 21:52:42 2015 -0700 @@ -184,6 +184,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{obj} =} onCleanup (@var{function})\n\ Create a special object that executes a given function upon destruction.\n\ +\n\ If the object is copied to multiple variables (or cell or struct array\n\ elements) or returned from a function, @var{function} will be executed after\n\ clearing the last copy of the object. Note that if multiple local onCleanup\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-range.cc --- a/libinterp/octave-value/ov-range.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-range.cc Sun May 03 21:52:42 2015 -0700 @@ -703,12 +703,14 @@ @deftypefnx {Built-in Function} {@var{old_val} =} allow_noninteger_range_as_index (@var{new_val})\n\ @deftypefnx {Built-in Function} {} allow_noninteger_range_as_index (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether non-integer\n\ -ranges are allowed as indices. This might be useful for @sc{matlab}\n\ -compatibility; however, it is still not entirely compatible because\n\ -@sc{matlab} treats the range expression differently in different contexts.\n\ +ranges are allowed as indices.\n\ +\n\ +This might be useful for @sc{matlab} compatibility; however, it is still not\n\ +entirely compatible because @sc{matlab} treats the range expression\n\ +differently in different contexts.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-struct.cc --- a/libinterp/octave-value/ov-struct.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-struct.cc Sun May 03 21:52:42 2015 -0700 @@ -1784,16 +1784,17 @@ @deftypefnx {Built-in Function} {@var{s} =} struct (@var{field1}, @var{value1}, @var{field2}, @var{value2}, @dots{})\n\ @deftypefnx {Built-in Function} {@var{s} =} struct (@var{obj})\n\ \n\ -Create a scalar or array structure and initialize its values. The\n\ -@var{field1}, @var{field2}, @dots{} variables are strings specifying the\n\ -names of the fields and the @var{value1}, @var{value2}, @dots{}\n\ -variables can be of any type.\n\ +Create a scalar or array structure and initialize its values.\n\ +\n\ +The @var{field1}, @var{field2}, @dots{} variables are strings specifying the\n\ +names of the fields and the @var{value1}, @var{value2}, @dots{} variables\n\ +can be of any type.\n\ \n\ -If the values are cell arrays, create a structure array and initialize\n\ -its values. The dimensions of each cell array of values must match.\n\ -Singleton cells and non-cell values are repeated so that they fill\n\ -the entire array. If the cells are empty, create an empty structure\n\ -array with the specified field names.\n\ +If the values are cell arrays, create a structure array and initialize its\n\ +values. The dimensions of each cell array of values must match. Singleton\n\ +cells and non-cell values are repeated so that they fill the entire array. \n\ +If the cells are empty, create an empty structure array with the specified\n\ +field names.\n\ \n\ If the argument is an object, return the underlying struct.\n\ \n\ @@ -1824,7 +1825,7 @@ @noindent\n\ The first case is an ordinary scalar struct---one field, one value. The\n\ second produces an empty struct array with one field and no values, since\n\ -s being passed an empty cell array of struct array values. When the value is\n\ +being passed an empty cell array of struct array values. When the value is\n\ a cell array containing a single entry, this becomes a scalar struct with\n\ that single entry as the value of the field. That single entry happens\n\ to be an empty cell array.\n\ @@ -2122,10 +2123,12 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} cell2struct (@var{cell}, @var{fields})\n\ @deftypefnx {Built-in Function} {} cell2struct (@var{cell}, @var{fields}, @var{dim})\n\ -Convert @var{cell} to a structure. The number of fields in @var{fields}\n\ -must match the number of elements in @var{cell} along dimension @var{dim},\n\ -that is @code{numel (@var{fields}) == size (@var{cell}, @var{dim})}.\n\ -If @var{dim} is omitted, a value of 1 is assumed.\n\ +Convert @var{cell} to a structure.\n\ +\n\ +The number of fields in @var{fields} must match the number of elements in\n\ +@var{cell} along dimension @var{dim}, that is\n\ +@code{numel (@var{fields}) == size (@var{cell}, @var{dim})}. If @var{dim}\n\ +is omitted, a value of 1 is assumed.\n\ \n\ @example\n\ @group\n\ @@ -2329,7 +2332,7 @@ structure levels to display.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{print_struct_array_contents}\n\ @end deftypefn") @@ -2346,13 +2349,13 @@ Query or set the internal variable that specifies whether to print struct\n\ array contents.\n\ \n\ -If true, values of struct array elements are printed.\n\ -This variable does not affect scalar structures whose elements are always\n\ -printed. In both cases, however, printing will be limited to\n\ -the number of levels specified by @var{struct_levels_to_print}.\n\ +If true, values of struct array elements are printed. This variable does\n\ +not affect scalar structures whose elements are always printed. In both\n\ +cases, however, printing will be limited to the number of levels specified\n\ +by @var{struct_levels_to_print}.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{struct_levels_to_print}\n\ @end deftypefn") diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-typeinfo.cc --- a/libinterp/octave-value/ov-typeinfo.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-typeinfo.cc Sun May 03 21:52:42 2015 -0700 @@ -614,8 +614,9 @@ @deftypefn {Built-in Function} {} typeinfo ()\n\ @deftypefnx {Built-in Function} {} typeinfo (@var{expr})\n\ \n\ -Return the type of the expression @var{expr}, as a string. If\n\ -@var{expr} is omitted, return a cell array of strings containing all the\n\ +Return the type of the expression @var{expr}, as a string.\n\ +\n\ +If @var{expr} is omitted, return a cell array of strings containing all the\n\ currently installed data types.\n\ @seealso{class, isa}\n\ @end deftypefn") diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov-usr-fcn.cc --- a/libinterp/octave-value/ov-usr-fcn.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov-usr-fcn.cc Sun May 03 21:52:42 2015 -0700 @@ -1049,7 +1049,7 @@ the subsasgn method of a user-defined class.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/octave-value/ov.cc --- a/libinterp/octave-value/ov.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/octave-value/ov.cc Sun May 03 21:52:42 2015 -0700 @@ -3024,17 +3024,15 @@ DEFUN (subsref, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} subsref (@var{val}, @var{idx})\n\ -Perform the subscripted element selection operation according to\n\ -the subscript specified by @var{idx}.\n\ +Perform the subscripted element selection operation according to the\n\ +subscript specified by @var{idx}.\n\ \n\ -The subscript @var{idx} is expected to be a structure array with\n\ -fields @samp{type} and @samp{subs}. Valid values for @samp{type}\n\ -are @samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.\n\ -The @samp{subs} field may be either @samp{\":\"} or a cell array\n\ -of index values.\n\ +The subscript @var{idx} is expected to be a structure array with fields\n\ +@samp{type} and @samp{subs}. Valid values for @samp{type} are\n\ +@samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}. The @samp{subs} field may\n\ +be either @samp{\":\"} or a cell array of index values.\n\ \n\ -The following example shows how to extract the first two columns of\n\ -a matrix\n\ +The following example shows how to extract the first two columns of a matrix\n\ \n\ @example\n\ @group\n\ @@ -3054,8 +3052,8 @@ @noindent\n\ Note that this is the same as writing @code{val(:,1:2)}.\n\ \n\ -If @var{idx} is an empty structure array with fields @samp{type}\n\ -and @samp{subs}, return @var{val}.\n\ +If @var{idx} is an empty structure array with fields @samp{type} and\n\ +@samp{subs}, return @var{val}.\n\ @seealso{subsasgn, substruct}\n\ @end deftypefn") { @@ -3087,17 +3085,16 @@ DEFUN (subsasgn, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} subsasgn (@var{val}, @var{idx}, @var{rhs})\n\ -Perform the subscripted assignment operation according to\n\ -the subscript specified by @var{idx}.\n\ +Perform the subscripted assignment operation according to the subscript\n\ +specified by @var{idx}.\n\ \n\ -The subscript @var{idx} is expected to be a structure array with\n\ -fields @samp{type} and @samp{subs}. Valid values for @samp{type}\n\ -are @samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}.\n\ -The @samp{subs} field may be either @samp{\":\"} or a cell array\n\ -of index values.\n\ +The subscript @var{idx} is expected to be a structure array with fields\n\ +@samp{type} and @samp{subs}. Valid values for @samp{type} are\n\ +@samp{\"()\"}, @samp{\"@{@}\"}, and @samp{\".\"}. The @samp{subs} field may\n\ +be either @samp{\":\"} or a cell array of index values.\n\ \n\ -The following example shows how to set the two first columns of a\n\ -3-by-3 matrix to zero.\n\ +The following example shows how to set the two first columns of a 3-by-3\n\ +matrix to zero.\n\ \n\ @example\n\ @group\n\ @@ -3113,8 +3110,8 @@ \n\ Note that this is the same as writing @code{val(:,1:2) = 0}.\n\ \n\ -If @var{idx} is an empty structure array with fields @samp{type}\n\ -and @samp{subs}, return @var{rhs}.\n\ +If @var{idx} is an empty structure array with fields @samp{type} and\n\ +@samp{subs}, return @var{rhs}.\n\ @seealso{subsref, substruct}\n\ @end deftypefn") { @@ -3279,9 +3276,10 @@ @deftypefnx {Built-in Function} {@var{old_val} =} disable_permutation_matrix (@var{new_val})\n\ @deftypefnx {Built-in Function} {} disable_permutation_matrix (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether permutation\n\ -matrices are stored in a special space-efficient format. The default\n\ -value is true. If this option is disabled Octave will store permutation\n\ -matrices as full matrices.\n\ +matrices are stored in a special space-efficient format.\n\ +\n\ +The default value is true. If this option is disabled Octave will store\n\ +permutation matrices as full matrices.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ @@ -3308,9 +3306,10 @@ @deftypefnx {Built-in Function} {@var{old_val} =} disable_diagonal_matrix (@var{new_val})\n\ @deftypefnx {Built-in Function} {} disable_diagonal_matrix (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether diagonal\n\ -matrices are stored in a special space-efficient format. The default\n\ -value is true. If this option is disabled Octave will store diagonal\n\ -matrices as full matrices.\n\ +matrices are stored in a special space-efficient format.\n\ +\n\ +The default value is true. If this option is disabled Octave will store\n\ +diagonal matrices as full matrices.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ @@ -3351,8 +3350,10 @@ @deftypefnx {Built-in Function} {@var{old_val} =} disable_range (@var{new_val})\n\ @deftypefnx {Built-in Function} {} disable_range (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether ranges are stored\n\ -in a special space-efficient format. The default value is true. If this\n\ -option is disabled Octave will store ranges as full matrices.\n\ +in a special space-efficient format.\n\ +\n\ +The default value is true. If this option is disabled Octave will store\n\ +ranges as full matrices.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/parse-tree/lex.ll --- a/libinterp/parse-tree/lex.ll Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/parse-tree/lex.ll Sun May 03 21:52:42 2015 -0700 @@ -1899,8 +1899,9 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} iskeyword ()\n\ @deftypefnx {Built-in Function} {} iskeyword (@var{name})\n\ -Return true if @var{name} is an Octave keyword. If @var{name}\n\ -is omitted, return a list of keywords.\n\ +Return true if @var{name} is an Octave keyword.\n\ +\n\ +If @var{name} is omitted, return a list of keywords.\n\ @seealso{isvarname, exist}\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/parse-tree/oct-parse.in.yy --- a/libinterp/parse-tree/oct-parse.in.yy Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/parse-tree/oct-parse.in.yy Sun May 03 21:52:42 2015 -0700 @@ -4316,15 +4316,15 @@ @deftypefnx {Built-in Function} {} autoload (@dots{}, \"remove\")\n\ Define @var{function} to autoload from @var{file}.\n\ \n\ -The second argument, @var{file}, should be an absolute file name or\n\ -a file name in the same directory as the function or script from which\n\ -the autoload command was run. @var{file} @emph{should not} depend on the\n\ -Octave load path.\n\ +The second argument, @var{file}, should be an absolute file name or a file\n\ +name in the same directory as the function or script from which the autoload\n\ +command was run. @var{file} @emph{should not} depend on the Octave load\n\ +path.\n\ \n\ -Normally, calls to @code{autoload} appear in PKG_ADD script files that\n\ -are evaluated when a directory is added to Octave's load path. To\n\ -avoid having to hardcode directory names in @var{file}, if @var{file}\n\ -is in the same directory as the PKG_ADD script then\n\ +Normally, calls to @code{autoload} appear in PKG_ADD script files that are\n\ +evaluated when a directory is added to Octave's load path. To avoid having\n\ +to hardcode directory names in @var{file}, if @var{file} is in the same\n\ +directory as the PKG_ADD script then\n\ \n\ @example\n\ autoload (\"foo\", \"bar.oct\");\n\ @@ -4543,10 +4543,13 @@ @deftypefnx {Built-in Function} {} mfilename (\"fullpathext\")\n\ Return the name of the currently executing file.\n\ \n\ -When called from outside an m-file return the empty string. Given the\n\ -argument @qcode{\"fullpath\"}, include the directory part of the file name,\n\ -but not the extension. Given the argument @qcode{\"fullpathext\"}, include\n\ -the directory part of the file name and the extension.\n\ +When called from outside an m-file return the empty string.\n\ +\n\ +Given the argument @qcode{\"fullpath\"}, include the directory part of the\n\ +file name, but not the extension.\n\ +\n\ +Given the argument @qcode{\"fullpathext\"}, include the directory part of\n\ +the file name and the extension.\n\ @end deftypefn") { octave_value retval; @@ -4732,8 +4735,10 @@ DEFUN (feval, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} feval (@var{name}, @dots{})\n\ -Evaluate the function named @var{name}. Any arguments after the first\n\ -are passed as inputs to the named function. For example,\n\ +Evaluate the function named @var{name}.\n\ +\n\ +Any arguments after the first are passed as inputs to the named function.\n\ +For example,\n\ \n\ @example\n\ @group\n\ @@ -4745,11 +4750,10 @@ @noindent\n\ calls the function @code{acos} with the argument @samp{-1}.\n\ \n\ -The function @code{feval} can also be used with function handles of\n\ -any sort (@pxref{Function Handles}). Historically, @code{feval} was\n\ -the only way to call user-supplied functions in strings, but\n\ -function handles are now preferred due to the cleaner syntax they\n\ -offer. For example,\n\ +The function @code{feval} can also be used with function handles of any sort\n\ +(@pxref{Function Handles}). Historically, @code{feval} was the only way to\n\ +call user-supplied functions in strings, but function handles are now\n\ +preferred due to the cleaner syntax they offer. For example,\n\ \n\ @example\n\ @group\n\ @@ -4783,12 +4787,12 @@ DEFUN (builtin, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@dots{}] =} builtin (@var{f}, @dots{})\n\ -Call the base function @var{f} even if @var{f} is overloaded to\n\ -another function for the given type signature.\n\ +Call the base function @var{f} even if @var{f} is overloaded to another\n\ +function for the given type signature.\n\ \n\ -This is normally useful when doing object-oriented programming and there\n\ -is a requirement to call one of Octave's base functions rather than\n\ -the overloaded one of a new class.\n\ +This is normally useful when doing object-oriented programming and there is\n\ +a requirement to call one of Octave's base functions rather than the\n\ +overloaded one of a new class.\n\ \n\ A trivial example which redefines the @code{sin} function to be the\n\ @code{cos} function shows how @code{builtin} works.\n\ @@ -4945,9 +4949,12 @@ @deftypefn {Built-in Function} {} eval (@var{try})\n\ @deftypefnx {Built-in Function} {} eval (@var{try}, @var{catch})\n\ Parse the string @var{try} and evaluate it as if it were an Octave\n\ -program. If that fails, evaluate the optional string @var{catch}.\n\ -The string @var{try} is evaluated in the current context,\n\ -so any results remain available after @code{eval} returns.\n\ +program.\n\ +\n\ +If execution fails, evaluate the optional string @var{catch}.\n\ +\n\ +The string @var{try} is evaluated in the current context, so any results\n\ +remain available after @code{eval} returns.\n\ \n\ The following example creates the variable @var{A} with the approximate\n\ value of 3.1416 in the current workspace.\n\ @@ -5113,9 +5120,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} evalin (@var{context}, @var{try})\n\ @deftypefnx {Built-in Function} {} evalin (@var{context}, @var{try}, @var{catch})\n\ -Like @code{eval}, except that the expressions are evaluated in the\n\ -context @var{context}, which may be either @qcode{\"caller\"} or\n\ -@qcode{\"base\"}.\n\ +Like @code{eval}, except that the expressions are evaluated in the context\n\ +@var{context}, which may be either @qcode{\"caller\"} or @qcode{\"base\"}.\n\ @seealso{eval, assignin}\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/parse-tree/pt-binop.cc --- a/libinterp/parse-tree/pt-binop.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/parse-tree/pt-binop.cc Sun May 03 21:52:42 2015 -0700 @@ -308,7 +308,7 @@ you should always use the @samp{&&} and @samp{||} operators.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") { diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/parse-tree/pt-eval.cc --- a/libinterp/parse-tree/pt-eval.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/parse-tree/pt-eval.cc Sun May 03 21:52:42 2015 -0700 @@ -1259,8 +1259,10 @@ @deftypefnx {Built-in Function} {@var{old_val} =} max_recursion_depth (@var{new_val})\n\ @deftypefnx {Built-in Function} {} max_recursion_depth (@var{new_val}, \"local\")\n\ Query or set the internal limit on the number of times a function may\n\ -be called recursively. If the limit is exceeded, an error message is\n\ -printed and control returns to the top level.\n\ +be called recursively.\n\ +\n\ +If the limit is exceeded, an error message is printed and control returns to\n\ +the top level.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ @@ -1288,9 +1290,11 @@ @deftypefnx {Built-in Function} {@var{old_val} =} silent_functions (@var{new_val})\n\ @deftypefnx {Built-in Function} {} silent_functions (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether internal\n\ -output from a function is suppressed. If this option is disabled,\n\ -Octave will display the results produced by evaluating expressions\n\ -within a function body that are not terminated with a semicolon.\n\ +output from a function is suppressed.\n\ +\n\ +If this option is disabled, Octave will display the results produced by\n\ +evaluating expressions within a function body that are not terminated with\n\ +a semicolon.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ diff -r 2645f9ef8c88 -r 075a5e2e1ba5 libinterp/parse-tree/pt-mat.cc --- a/libinterp/parse-tree/pt-mat.cc Sun May 03 17:00:11 2015 -0700 +++ b/libinterp/parse-tree/pt-mat.cc Sun May 03 21:52:42 2015 -0700 @@ -1391,8 +1391,10 @@ @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\ @deftypefnx {Built-in Function} {} string_fill_char (@var{new_val}, \"local\")\n\ Query or set the internal variable used to pad all rows of a character\n\ -matrix to the same length; It must be a single character. The default\n\ -value is @qcode{\" \"} (a single space). For example:\n\ +matrix to the same length.\n\ +\n\ +The value must be a single character and the default is @qcode{\" \"} (a\n\ +single space). For example:\n\ \n\ @example\n\ @group\n\ @@ -1405,7 +1407,7 @@ @end example\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") {