Mercurial > octave-nkf
changeset 13929:9cae456085c2
Grammarcheck of documentation before 3.6.0 release.
* accumarray.m, blkdiag.m, nargoutchk.m, nthargout.m, profexplore.m, profile.m,
computer.m, orderfields.m, recycle.m, version.m, sqp.m, matlabroot.m,
__plt_get_axis_arg__.m, isonormals.m, isosurface.m, __fltk_file_filter__.m,
__is_function__.m, __uigetdir_fltk__.m, __uigetfile_fltk__.m,
__uiobject_split_args__.m, __uiputfile_fltk__.m, uicontextmenu.m, uiresume.m,
uiwait.m, mkpp.m, ppder.m, residue.m, addpref.m, getpref.m, ispref.m,
loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, fftshift.m, bicg.m,
bicgstab.m, cgs.m, gmres.m, __sprand_impl__.m, quantile.m, deblank.m,
strsplit.m, addtodate.m, bsxfun.cc, kron.cc, regexp.cc, data.cc, file-io.cc,
graphics.cc, load-save.cc, mappers.cc: Grammarcheck of documentation
before 3.6.0 release.
line wrap: on
line diff
--- a/scripts/general/accumarray.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/accumarray.m Wed Nov 23 08:38:19 2011 -0800 @@ -24,14 +24,14 @@ ## Create an array by accumulating the elements of a vector into the ## positions defined by their subscripts. The subscripts are defined by ## the rows of the matrix @var{subs} and the values by @var{vals}. Each -## row of @var{subs} corresponds to one of the values in @var{vals}. If +## row of @var{subs} corresponds to one of the values in @var{vals}. If ## @var{vals} is a scalar, it will be used for each of the row of ## @var{subs}. ## ## The size of the matrix will be determined by the subscripts -## themselves. However, if @var{sz} is defined it determines the matrix -## size. The length of @var{sz} must correspond to the number of columns -## in @var{subs}. An exception is if @var{subs} has only one column, in +## themselves. However, if @var{sz} is defined it determines the matrix +## size. The length of @var{sz} must correspond to the number of columns +## in @var{subs}. An exception is if @var{subs} has only one column, in ## which case @var{sz} may be the dimensions of a vector and the subscripts ## of @var{subs} are taken as the indices into it. ## @@ -42,14 +42,14 @@ ## function should not depend on the order of the subscripts. ## ## The elements of the returned array that have no subscripts associated -## with them are set to zero. Defining @var{fillval} to some other value -## allows these values to be defined. This behaviour changes, however, -## for certain values of @var{func}. If @var{func} is @code{min} +## with them are set to zero. Defining @var{fillval} to some other value +## allows these values to be defined. This behaviour changes, however, +## for certain values of @var{func}. If @var{func} is @code{min} ## (respectively, @code{max}) then the result will be filled with the ## minimum (respectively, maximum) integer if @var{vals} is of integral ## type, logical false (respectively, logical true) if @var{vals} is of ## logical type, zero if @var{fillval} is zero and all values are -## nonpositive (respectively, nonnegative), and NaN otherwise. +## nonpositive (respectively, non-negative), and NaN otherwise. ## ## By default @code{accumarray} returns a full matrix. If ## @var{issparse} is logically true, then a sparse matrix is returned @@ -57,7 +57,7 @@ ## ## The following @code{accumarray} example constructs a frequency table ## that in the first column counts how many occurrences each number in -## the second column has, taken from the vector @var{x}. Note the usage +## the second column has, taken from the vector @var{x}. Note the usage ## of @code{unique} for assigning to all repeated elements of @var{x} ## the same index (@pxref{doc-unique}). ## @@ -74,7 +74,7 @@ ## @end group ## @end example ## -## Another example, where the result is a multidimensional 3D array and +## Another example, where the result is a multi-dimensional 3-D array and ## the default value (zero) appears in the output: ## ## @example @@ -91,9 +91,9 @@ ## ## The complexity in the non-sparse case is generally O(M+N), where N is ## the number of subscripts and M is the maximum subscript (linearized -## in multi-dimensional case). If @var{func} is one of @code{@@sum} +## in multi-dimensional case). If @var{func} is one of @code{@@sum} ## (default), @code{@@max}, @code{@@min} or @code{@@(x) @{x@}}, an -## optimized code path is used. Note that for general reduction function +## optimized code path is used. Note that for general reduction function ## the interpreter overhead can play a major part and it may be more ## efficient to do multiple accumarray calls and compute the results in ## a vectorized manner.
--- a/scripts/general/blkdiag.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/blkdiag.m Wed Nov 23 08:38:19 2011 -0800 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} blkdiag (@var{A}, @var{B}, @var{C}, @dots{}) ## Build a block diagonal matrix from @var{A}, @var{B}, @var{C}, @dots{} ## All the arguments must be numeric and are two-dimensional matrices or -## scalars. If any argument is of type sparse, the output will also be +## scalars. If any argument is of type sparse, the output will also be ## sparse. ## @seealso{diag, horzcat, vertcat, sparse} ## @end deftypefn
--- a/scripts/general/nargoutchk.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/nargoutchk.m Wed Nov 23 08:38:19 2011 -0800 @@ -25,11 +25,11 @@ ## Check for correct number of output arguments. ## ## On the first form, returns an error unless the number of arguments in its -## caller is between the values of @var{minargs} and @var{maxargs}. It does -## nothing otherwise. Note that this function evaluates the value of +## caller is between the values of @var{minargs} and @var{maxargs}. It does +## nothing otherwise. Note that this function evaluates the value of ## @code{nargout} on the caller so its value must have not been tampered with. ## -## Both @var{minargs} and @var{maxargs} need to be a numeric scalar. Zero, Inf +## Both @var{minargs} and @var{maxargs} need to be a numeric scalar. Zero, Inf ## and negative are all valid, and they can have the same value. ## ## For backward compatibility reasons, the other forms return an appropriate
--- a/scripts/general/nthargout.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/nthargout.m Wed Nov 23 08:38:19 2011 -0800 @@ -20,10 +20,10 @@ ## @deftypefn {Function File} {} nthargout (@var{n}, @var{func}, @dots{}) ## @deftypefnx {Function File} {} nthargout (@var{n}, @var{ntot}, @var{func}, @dots{}) ## Return the @var{n}th output argument of function given by the -## function handle or string @var{func}. Any arguments after @var{func} -## are passed to @var{func}. The total number of arguments to call +## function handle or string @var{func}. Any arguments after @var{func} +## are passed to @var{func}. The total number of arguments to call ## @var{func} with can be passed in @var{ntot}; by default @var{ntot} -## is @var{n}. The input @var{n} can also be a vector of indices of the +## is @var{n}. The input @var{n} can also be a vector of indices of the ## output, in which case the output will be a cell array of the ## requested output arguments. ##
--- a/scripts/general/profexplore.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/profexplore.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} profexplore (@var{data}) +## @deftypefn {Function File} {} profexplore (@var{data}) ## Interactively explore hierarchical profiler output. ## ## Assuming @var{data} is the structure with profile data returned by
--- a/scripts/general/profile.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/general/profile.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,10 +17,10 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} profile on -## @deftypefnx {Function File} {} profile off -## @deftypefnx {Function File} {} profile resume -## @deftypefnx {Function File} {} profile clear +## @deftypefn {Command} {} profile on +## @deftypefnx {Command} {} profile off +## @deftypefnx {Command} {} profile resume +## @deftypefnx {Command} {} profile clear ## @deftypefnx {Function File} {@var{S} =} profile ('status') ## @deftypefnx {Function File} {@var{T} =} profile ('info') ## Control the built-in profiler.
--- a/scripts/miscellaneous/computer.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/miscellaneous/computer.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{c}, @var{maxsize}, @var{endian}] =} computer () +## @deftypefn {Function File} {[@var{c}, @var{maxsize}, @var{endian}] =} computer () ## @deftypefnx {Function File} {@var{arch} =} computer ("arch") ## Print or return a string of the form @var{cpu}-@var{vendor}-@var{os} ## that identifies the kind of computer Octave is running on. If invoked
--- a/scripts/miscellaneous/orderfields.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/miscellaneous/orderfields.m Wed Nov 23 08:38:19 2011 -0800 @@ -36,7 +36,6 @@ ## Examples: ## ## @example -## @group ## s = struct("d", 4, "b", 2, "a", 1, "c", 3); ## t1 = orderfields(s) ## @result{} t1 = @@ -81,7 +80,6 @@ ## 4 ## 2 ## 3 -## @end group ## @end example ## ## @seealso{getfield, rmfield, isfield, isstruct, fieldnames, struct}
--- a/scripts/miscellaneous/recycle.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/miscellaneous/recycle.m Wed Nov 23 08:38:19 2011 -0800 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{current_state}} recycle () -## @deftypefnx {Function File} {@var{old_state}} recycle (@var{new_state}) +## @deftypefnx {Function File} {@var{old_state}} recycle (@var{new_state}) ## Query or set the preference for recycling deleted files. ## ## Recycling files instead of permanently deleting them is currently not
--- a/scripts/miscellaneous/version.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/miscellaneous/version.m Wed Nov 23 08:38:19 2011 -0800 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} version () ## Return the version number of Octave, as a string. ## -## This is an alias for the function @code{OCTAVE_VERSION} provided for +## This is an alias for the function @w{@env{OCTAVE_VERSION}} provided for ## compatibility ## @seealso{OCTAVE_VERSION}. ## @end deftypefn
--- a/scripts/optimization/sqp.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/optimization/sqp.m Wed Nov 23 08:38:19 2011 -0800 @@ -75,7 +75,7 @@ ## formula is used to approximate the Hessian. ## ## When supplied, the gradient function @code{@var{phi}@{2@}} must accept -## one vector argument and return a vector. When supplifed, the Hessian +## one vector argument and return a vector. When supplifed, the Hessian ## function @code{@var{phi}@{3@}} must accept one vector argument and ## return a matrix. ## @@ -83,7 +83,7 @@ ## handles pointing to functions that compute the equality constraints ## and the inequality constraints, respectively. If the problem does ## not have equality (or inequality) constraints, then use an empty -## matrix ([]) for @var{g} (or @var{h}). When supplied, these equality +## matrix ([]) for @var{g} (or @var{h}). When supplied, these equality ## and inequality constraint functions must accept one vector argument ## and return a vector. ## @@ -113,16 +113,16 @@ ## and upper bounds on @var{x}. These must be consistent with the ## equality and inequality constraints @var{g} and @var{h}. If the ## arguments are vectors then @var{x}(i) is bound by @var{lb}(i) and -## @var{ub}(i). A bound can also be a scalar in which case all elements +## @var{ub}(i). A bound can also be a scalar in which case all elements ## of @var{x} will share the same bound. If only one bound (lb, ub) is ## specified then the other will default to (-@var{realmax}, ## +@var{realmax}). ## ## The seventh argument @var{maxiter} specifies the maximum number of -## iterations. The default value is 100. +## iterations. The default value is 100. ## ## The eighth argument @var{tol} specifies the tolerance for the -## stopping criteria. The default value is @code{sqrt(eps)}. +## stopping criteria. The default value is @code{sqrt(eps)}. ## ## The value returned in @var{info} may be one of the following: ##
--- a/scripts/path/matlabroot.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/path/matlabroot.m Wed Nov 23 08:38:19 2011 -0800 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} matlabroot () ## Return the name of the top-level Octave installation directory. ## -## This is an alias for the function @code{OCTAVE_HOME} provided +## This is an alias for the function @w{@code{OCTAVE_HOME}} provided ## for compatibility. ## @seealso{OCTAVE_HOME} ## @end deftypefn
--- a/scripts/plot/__plt_get_axis_arg__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/__plt_get_axis_arg__.m Wed Nov 23 08:38:19 2011 -0800 @@ -33,7 +33,7 @@ nogca = false; endif - ## Figure handles are integers, but object handles are non integer, + ## Figure handles are integers, but object handles are non-integer, ## therefore ignore integer scalars. if (nargin > 1 && length (varargin) > 0 && isnumeric (varargin{1}) && numel (varargin{1}) == 1 && ishandle (varargin{1}(1))
--- a/scripts/plot/isonormals.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/isonormals.m Wed Nov 23 08:38:19 2011 -0800 @@ -45,8 +45,8 @@ ## given by the patch handle @var{p}. ## ## For example: +## @c Set example in small font to prevent overfull line ## -## @c Set example in small font to prevent overfull line ## @smallexample ## function [] = isofinish (p) ## set (gca, "PlotBoxAspectRatioMode", "manual", ...
--- a/scripts/plot/isosurface.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/isosurface.m Wed Nov 23 08:38:19 2011 -0800 @@ -70,8 +70,8 @@ ## will directly draw a random isosurface geometry in a graphics window. ## Another example for an isosurface geometry with different additional ## coloring +## @c Set example in small font to prevent overfull line ## -## @c Set example in small font to prevent overfull line ## @smallexample ## N = 15; # Increase number of vertices in each direction ## iso = .4; # Change isovalue to .1 to display a sphere
--- a/scripts/plot/private/__fltk_file_filter__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__fltk_file_filter__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{filterspec} =} __fltk_file_filter__ (@var{filter}) +## @deftypefn {Function File} {@var{filterspec} =} __fltk_file_filter__ (@var{filter}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/private/__is_function__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__is_function__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{result} =} __is_function__ (@var{func}) +## @deftypefn {Function File} {@var{result} =} __is_function__ (@var{func}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/private/__uigetdir_fltk__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__uigetdir_fltk__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{dirname} =} __uigetdir_fltk__ (@var{start_path}, @var{dialog_title}) +## @deftypefn {Function File} {@var{dirname} =} __uigetdir_fltk__ (@var{start_path}, @var{dialog_title}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/private/__uigetfile_fltk__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__uigetfile_fltk__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uigetfile_fltk__ () +## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uigetfile_fltk__ () ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/private/__uiobject_split_args__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__uiobject_split_args__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{p}, @var{args}] =} __uiobject_split_args__ (@var{who}, @var{args}, @var{parent_type}, @var{use_gcf}) +## @deftypefn {Function File} {[@var{p}, @var{args}] =} __uiobject_split_args__ (@var{who}, @var{args}, @var{parent_type}, @var{use_gcf}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/private/__uiputfile_fltk__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/private/__uiputfile_fltk__.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uiputfile_fltk__ () +## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} __uiputfile_fltk__ () ## Undocumented internal function. ## @end deftypefn
--- a/scripts/plot/uicontextmenu.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/uicontextmenu.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uicontextmenu ('Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uicontextmenu ('Name', value, @dots{}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/uiresume.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/uiresume.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} uiresume (@var{h}) -## Resumes program execution suspended with @code{uiwait}. The handle @var{h} -## must be the same as the on specified in @code{uiwait}. If the handle +## @deftypefn {Function File} uiresume (@var{h}) +## Resume program execution suspended with @code{uiwait}. The handle @var{h} +## must be the same as the on specified in @code{uiwait}. If the handle ## is invalid or there is no @code{uiwait} call pending for the figure ## with handle @var{h}, this function does nothing. ## @seealso{uiwait}
--- a/scripts/plot/uiwait.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/plot/uiwait.m Wed Nov 23 08:38:19 2011 -0800 @@ -20,17 +20,17 @@ ## @deftypefn {Function File} uiwait ## @deftypefnx {Function File} uiwait (@var{h}) ## @deftypefnx {Function File} uiwait (@var{h}, @var{timeout}) -## Suspends program execution until the figure with handle @var{h} is -## deleted or @code{uiresume} is called. When no figure handle is specified, +## Suspend program execution until the figure with handle @var{h} is +## deleted or @code{uiresume} is called. When no figure handle is specified, ## this function uses the current figure. ## ## If the figure handle is invalid or there is no current figure, this ## functions returns immediately. ## ## When specified, @var{timeout} defines the number of seconds to wait -## for the figure deletion or the @code{uiresume} call. The timeout value +## for the figure deletion or the @code{uiresume} call. The timeout value ## must be at least 1. If a smaller value is specified, a warning is issued -## and a timeout value of 1 is used instead. If a non integer value is +## and a timeout value of 1 is used instead. If a non-integer value is ## specified, it is truncated towards 0. If @var{timeout} is not specified, ## the program execution is suspended indefinitely. ## @seealso{uiresume, waitfor}
--- a/scripts/polynomial/mkpp.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/polynomial/mkpp.m Wed Nov 23 08:38:19 2011 -0800 @@ -22,7 +22,7 @@ ## ## Construct a piece-wise polynomial (pp) structure from sample points ## @var{breaks} and coefficients @var{coefs}. @var{breaks} must be a vector of -## strictly increasing values. The number of intervals is given by +## strictly increasing values. The number of intervals is given by ## @code{@var{ni} = length (@var{breaks}) - 1}. ## When @var{m} is the polynomial order @var{coefs} must be of ## size: @var{ni} x @var{m} + 1. @@ -33,11 +33,11 @@ ## lowest (@var{0}). ## ## @var{coefs} may also be a multi-dimensional array, specifying a vector-valued -## or array-valued polynomial. In that case the polynomial order is defined +## or array-valued polynomial. In that case the polynomial order is defined ## by the length of the last dimension of @var{coefs}. ## The size of first dimension(s) are given by the scalar or -## vector @var{d}. If @var{d} is not given it is set to @code{1}. -## In any case @var{coefs} is reshaped to a 2d matrix of +## vector @var{d}. If @var{d} is not given it is set to @code{1}. +## In any case @var{coefs} is reshaped to a 2-D matrix of ## size @code{[@var{ni}*prod(@var{d} @var{m})] } ## ## @seealso{unmkpp, ppval, spline}
--- a/scripts/polynomial/ppder.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/polynomial/ppder.m Wed Nov 23 08:38:19 2011 -0800 @@ -18,8 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {ppd =} ppder (pp, m) -## Computes the piecewise @var{m}-th derivative of a piecewise polynomial -## struct @var{pp}. If @var{m} is omitted the first derivate is +## Compute the piecewise @var{m}-th derivative of a piecewise polynomial +## struct @var{pp}. If @var{m} is omitted the first derivate is ## calculated. ## @seealso{mkpp, ppval, ppint} ## @end deftypefn
--- a/scripts/polynomial/residue.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/polynomial/residue.m Wed Nov 23 08:38:19 2011 -0800 @@ -18,7 +18,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{r}, @var{p}, @var{k}, @var{e}] =} residue (@var{b}, @var{a}) +## @deftypefn {Function File} {[@var{r}, @var{p}, @var{k}, @var{e}] =} residue (@var{b}, @var{a}) ## @deftypefnx {Function File} {[@var{b}, @var{a}] =} residue (@var{r}, @var{p}, @var{k}) ## @deftypefnx {Function File} {[@var{b}, @var{a}] =} residue (@var{r}, @var{p}, @var{k}, @var{e}) ## The first calling form computes the partial fraction expansion for the
--- a/scripts/prefs/addpref.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/addpref.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} addpref (@var{group}, @var{pref}, @var{val}) +## @deftypefn {Function File} {} addpref (@var{group}, @var{pref}, @var{val}) ## Add a preference @var{pref} and associated value @var{val} to the ## named preference group @var{group}. ##
--- a/scripts/prefs/getpref.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/getpref.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} getpref (@var{group}, @var{pref}, @var{default}) +## @deftypefn {Function File} {} getpref (@var{group}, @var{pref}, @var{default}) ## Return the preference value corresponding to the named preference ## @var{pref} in the preference group @var{group}. ##
--- a/scripts/prefs/ispref.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/ispref.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ispref (@var{group}, @var{pref}) +## @deftypefn {Function File} {} ispref (@var{group}, @var{pref}) ## Return true if the named preference @var{pref} exists in the ## preference group @var{group}. ## @@ -26,7 +26,7 @@ ## The preference @var{pref} may be a character string or a cell array ## of character strings. ## -## If @var{pref} is not specified, return true if the the preference +## If @var{pref} is not specified, return true if the preference ## group @var{group} exists. ## @seealso{addpref, getpref, rmpref, setpref} ## @end deftypefn
--- a/scripts/prefs/private/loadprefs.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/private/loadprefs.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} loadprefs () +## @deftypefn {Function File} {} loadprefs () ## Undocumented internal function. ## @end deftypefn
--- a/scripts/prefs/private/prefsfile.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/private/prefsfile.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} prefsfile () +## @deftypefn {Function File} {} prefsfile () ## Undocumented internal function. ## @end deftypefn
--- a/scripts/prefs/private/saveprefs.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/private/saveprefs.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} saveprefs () +## @deftypefn {Function File} {} saveprefs () ## Undocumented internal function. ## @end deftypefn
--- a/scripts/prefs/rmpref.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/rmpref.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} rmpref (@var{group}, @var{pref}) +## @deftypefn {Function File} {} rmpref (@var{group}, @var{pref}) ## Remove the named preference @var{pref} from the preference group ## @var{group}. ##
--- a/scripts/prefs/setpref.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/prefs/setpref.m Wed Nov 23 08:38:19 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} setpref (@var{group}, @var{pref}, @var{val}) +## @deftypefn {Function File} {} setpref (@var{group}, @var{pref}, @var{val}) ## Set a preference @var{pref} to the given @var{val} in the named ## preference group @var{group}. ##
--- a/scripts/signal/fftshift.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/signal/fftshift.m Wed Nov 23 08:38:19 2011 -0800 @@ -31,6 +31,7 @@ ## f = [ -(ceil((N-1)/2):-1:1)*df 0 (1:floor((N-1)/2))*df ] ## @end example ## +## @noindent ## where @math{df} = 1 / @math{dt}. ## ## If @var{x} is a matrix, the same holds for rows and columns. If
--- a/scripts/sparse/bicg.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/sparse/bicg.m Wed Nov 23 08:38:19 2011 -0800 @@ -16,17 +16,19 @@ ## -*- texinfo -*- ## -## @deftypefn {Function File} {@var{x} =} bicg (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) +## @deftypefn {Function File} {@var{x} =} bicg (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## @deftypefnx {Function File} {@var{x} =} bicg (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{P}) -## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicg (@var{A}, @var{b}, ...) +## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicg (@var{A}, @var{b}, @dots{}) ## Solve @code{A x = b} using the Bi-conjugate gradient iterative method. ## ## @itemize @minus ## @item @var{rtol} is the relative tolerance, if not given ## or set to [] the default value 1e-6 is used. +## ## @item @var{maxit} the maximum number of outer iterations, ## if not given or set to [] the default value ## @code{min (20, numel (b))} is used. +## ## @item @var{x0} the initial guess, if not given or set to [] ## the default value @code{zeros (size (b))} is used. ## @end itemize @@ -47,16 +49,21 @@ ## @item @var{flag} indicates the exit status: ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance +## ## @item 1: the maximum number of iterations was reached before convergence +## ## @item 3: the algorithm reached stagnation ## @end itemize ## (the value 2 is unused but skipped for compatibility). +## ## @item @var{relres} is the final value of the relative residual. +## ## @item @var{iter} is the number of iterations performed. +## ## @item @var{resvec} is a vector containing the relative residual at each iteration. ## @end itemize ## -## @seealso{bicgstab,cgs,gmres,pcg} +## @seealso{bicgstab, cgs, gmres, pcg} ## ## @end deftypefn
--- a/scripts/sparse/bicgstab.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/sparse/bicgstab.m Wed Nov 23 08:38:19 2011 -0800 @@ -19,17 +19,20 @@ ## -*- texinfo -*- ## -## @deftypefn {Function File} {@var{x} =} bicgstab (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) +## @deftypefn {Function File} {@var{x} =} bicgstab (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## @deftypefnx {Function File} {@var{x} =} bicgstab (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{P}) -## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicgstab (@var{A}, @var{b}, ...) -## Solve @code{A x = b} using the stabilizied Bi-conjugate gradient iterative method. +## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} bicgstab (@var{A}, @var{b}, @dots{}) +## Solve @code{A x = b} using the stabilizied Bi-conjugate gradient iterative +## method. ## ## @itemize @minus ## @item @var{rtol} is the relative tolerance, if not given or set to ## [] the default value 1e-6 is used. +## ## @item @var{maxit} the maximum number of outer iterations, if not ## given or set to [] the default value @code{min (20, numel (b))} is ## used. +## ## @item @var{x0} the initial guess, if not given or set to [] the ## default value @code{zeros (size (b))} is used. ## @end itemize @@ -38,8 +41,9 @@ ## inline function @code{f} such that @code{f(x) = A*x}. ## ## The preconditioner @var{P} is given as @code{P = M1 * M2}. -## Both @var{M1} and @var{M2} can be passed as a matrix or as a function handle or -## inline function @code{g} such that @code{g(x) = M1 \ x} or @code{g(x) = M2 \ x}. +## Both @var{M1} and @var{M2} can be passed as a matrix or as a function +## handle or inline function @code{g} such that @code{g(x) = M1 \ x} or +## @code{g(x) = M2 \ x}. ## ## If called with more than one output parameter ## @@ -47,16 +51,21 @@ ## @item @var{flag} indicates the exit status: ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance +## ## @item 1: the maximum number of iterations was reached before convergence +## ## @item 3: the algorithm reached stagnation ## @end itemize ## (the value 2 is unused but skipped for compatibility). +## ## @item @var{relres} is the final value of the relative residual. +## ## @item @var{iter} is the number of iterations performed. +## ## @item @var{resvec} is a vector containing the relative residual at each iteration. ## @end itemize ## -## @seealso{bicg,cgs,gmres,pcg} +## @seealso{bicg, cgs, gmres, pcg} ## ## @end deftypefn
--- a/scripts/sparse/cgs.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/sparse/cgs.m Wed Nov 23 08:38:19 2011 -0800 @@ -19,18 +19,20 @@ ## -*- texinfo -*- ## -## @deftypefn {Function File} {@var{x} =} cgs (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) +## @deftypefn {Function File} {@var{x} =} cgs (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2}, @var{x0}) ## @deftypefnx {Function File} {@var{x} =} cgs (@var{A}, @var{b}, @var{rtol}, @var{maxit}, @var{P}) -## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} cgs (@var{A}, @var{b}, ...) +## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} cgs (@var{A}, @var{b}, @dots{}) ## Solve @code{A x = b}, where @var{A} is a square matrix, using the ## Conjugate Gradients Squared method. ## ## @itemize @minus ## @item @var{rtol} is the relative tolerance, if not given or set to [] ## the default value 1e-6 is used. +## ## @item @var{maxit} the maximum number of outer iterations, if not ## given or set to [] the default value @code{min (20, numel (b))} is ## used. +## ## @item @var{x0} the initial guess, if not given or set to [] the ## default value @code{zeros (size (b))} is used. ## @end itemize @@ -49,17 +51,22 @@ ## @item @var{flag} indicates the exit status: ## @itemize @minus ## @item 0: iteration converged to the within the chosen tolerance +## ## @item 1: the maximum number of iterations was reached before convergence +## ## @item 3: the algorithm reached stagnation ## @end itemize ## (the value 2 is unused but skipped for compatibility). +## ## @item @var{relres} is the final value of the relative residual. +## ## @item @var{iter} is the number of iterations performed. +## ## @item @var{resvec} is a vector containing the relative residual at ## each iteration. ## @end itemize ## -## @seealso{pcg,bicgstab,bicg,gmres} +## @seealso{pcg, bicgstab, bicg, gmres} ## @end deftypefn function [x, flag, relres, iter, resvec] = cgs (A, b, tol, maxit, M1, M2, x0)
--- a/scripts/sparse/gmres.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/sparse/gmres.m Wed Nov 23 08:38:19 2011 -0800 @@ -51,13 +51,19 @@ ## @item @var{flag} indicates the exit status: ## @table @asis ## @item 0 : iteration converged to within the specified tolerance +## ## @item 1 : maximum number of iterations exceeded +## ## @item 2 : unused, but skipped for compatibility +## ## @item 3 : algorithm reached stagnation ## @end table +## ## @item @var{relres} is the final value of the relative residual. +## ## @item @var{iter} is a vector containing the number of outer iterations and ## total iterations performed. +## ## @item @var{resvec} is a vector containing the relative residual at each ## iteration. ## @end itemize
--- a/scripts/sparse/private/__sprand_impl__.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/sparse/private/__sprand_impl__.m Wed Nov 23 08:38:19 2011 -0800 @@ -21,7 +21,7 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} __sprand_impl__ (@var{s}, @var{randfun}) +## @deftypefn {Function File} {} __sprand_impl__ (@var{s}, @var{randfun}) ## @deftypefnx {Function File} {} __sprand_impl__ (@var{m}, @var{n}, @var{d}, @var{funname}, @var{randfun}) ## Undocumented internal function. ## @end deftypefn
--- a/scripts/statistics/base/quantile.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/statistics/base/quantile.m Wed Nov 23 08:38:19 2011 -0800 @@ -89,8 +89,8 @@ ## @end itemize ## ## Examples: +## @c Set example in small font to prevent overfull line ## -## @c Set example in small font to prevent overfull line ## @smallexample ## @group ## x = randi (1000, [10, 1]); # Create empirical data in range 1-1000
--- a/scripts/strings/deblank.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/strings/deblank.m Wed Nov 23 08:38:19 2011 -0800 @@ -24,6 +24,7 @@ ## string element. ## ## Examples: +## ## @example ## @group ## deblank (" abc ")
--- a/scripts/strings/strsplit.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/strings/strsplit.m Wed Nov 23 08:38:19 2011 -0800 @@ -28,7 +28,9 @@ ## boundaries. ## ## Example: +## ## @example +## @group ## strsplit ("a,b,c", ",") ## @result{} ## @{ @@ -44,7 +46,6 @@ ## [1,2] = b ## [1,3] = cde ## @} -## @group ## @end group ## @end example ## @seealso{strtok}
--- a/scripts/time/addtodate.m Tue Nov 22 21:22:46 2011 -0800 +++ b/scripts/time/addtodate.m Wed Nov 23 08:38:19 2011 -0800 @@ -18,7 +18,8 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{d} =} addtodate (@var{d}, @var{q}, @var{f}) -## Add @var{q} amount of time (with units @var{f}) to the serial datenum, @var{d}. +## Add @var{q} amount of time (with units @var{f}) to the serial datenum, +## @var{d}. ## ## @var{f} must be one of "year", "month", "day", "hour", "minute", "second", ## or "millisecond".
--- a/src/DLD-FUNCTIONS/bsxfun.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/DLD-FUNCTIONS/bsxfun.cc Wed Nov 23 08:38:19 2011 -0800 @@ -315,13 +315,13 @@ The binary singleton expansion function applier does what its name\n\ suggests: applies a binary function @var{f} element-by-element to two\n\ array arguments @var{A} and @var{B}, and expands as necessary\n\ -singleton dimensions in either input argument. @var{f} is a function\n\ +singleton dimensions in either input argument. @var{f} is a function\n\ handle, inline function, or string containing the name of the function\n\ -to evaluate. The function @var{f} must be capable of accepting two\n\ +to evaluate. The function @var{f} must be capable of accepting two\n\ column-vector arguments of equal length, or one column vector argument\n\ and a scalar.\n\ \n\ -The dimensions of @var{A} and @var{B} must be equal or singleton. The\n\ +The dimensions of @var{A} and @var{B} must be equal or singleton. The\n\ singleton dimensions of the arrays will be expanded to the same\n\ dimensionality as the other array.\n\ @seealso{arrayfun, cellfun}\n\
--- a/src/DLD-FUNCTIONS/kron.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/DLD-FUNCTIONS/kron.cc Wed Nov 23 08:38:19 2011 -0800 @@ -239,7 +239,7 @@ DEFUN_DLD (kron, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} kron (@var{A}, @var{B})\n\ +@deftypefn {Loadable Function} {} kron (@var{A}, @var{B})\n\ @deftypefnx {Loadable Function} {} kron (@var{A1}, @var{A2}, @dots{})\n\ Form the Kronecker product of two or more matrices, defined block by \n\ block as\n\
--- a/src/DLD-FUNCTIONS/regexp.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/DLD-FUNCTIONS/regexp.cc Wed Nov 23 08:38:19 2011 -0800 @@ -941,6 +941,7 @@ A structure containing the text of each matched named token, with the name\n\ being used as the fieldname. A named token is denoted by\n\ @code{(?<name>@dots{})}.\n\ +\n\ @item sp\n\ A cell array of the text not returned by match.\n\ @end table\n\
--- a/src/data.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/data.cc Wed Nov 23 08:38:19 2011 -0800 @@ -2413,14 +2413,17 @@ @var{a}(@var{idx1}, @var{idx2}, @dots{})\n\ @end example\n\ \n\ -Note that the indices do not have to be numerical. For example\n\ +Note that the indices do not have to be numerical. For example,\n\ \n\ @example\n\ +@group\n\ @var{a} = 1;\n\ @var{b} = ones (2, 3);\n\ numel (@var{a}, @var{b});\n\ +@end group\n\ @end example\n\ \n\ +@noindent\n\ will return 6, as this is the number of ways to index with @var{b}.\n\ \n\ This method is also called when an object appears as lvalue with cs-list\n\
--- a/src/file-io.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/file-io.cc Wed Nov 23 08:38:19 2011 -0800 @@ -1203,7 +1203,7 @@ string @var{string} instead of from a stream. Reaching the end of the\n\ string is treated as an end-of-file condition. In addition to the values\n\ returned by @code{fscanf}, the index of the next character to be read\n\ -is returned in in @var{pos}.\n\ +is returned in @var{pos}.\n\ @seealso{fscanf, scanf, sprintf}\n\ @end deftypefn") {
--- a/src/graphics.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/graphics.cc Wed Nov 23 08:38:19 2011 -0800 @@ -9572,32 +9572,32 @@ @deftypefnx {Built-in Function} {} waitfor (@var{h}, @var{prop})\n\ @deftypefnx {Built-in Function} {} waitfor (@var{h}, @var{prop}, @var{value})\n\ @deftypefnx {Built-in Function} {} waitfor (@dots{}, \"timeout\", @var{timeout})\n\ -Suspends the execution of the current program until a condition is\n\ -satisfied on the graphics handle @var{h}. While the program is suspended\n\ +Suspend the execution of the current program until a condition is\n\ +satisfied on the graphics handle @var{h}. While the program is suspended\n\ graphics events are still being processed normally, allowing callbacks to\n\ -modify the state of graphics objects. This function is reentrant and can be\n\ +modify the state of graphics objects. This function is reentrant and can be\n\ called from a callback, while another @code{waitfor} call is pending at\n\ top-level.\n\ \n\ In the first form, program execution is suspended until the graphics object\n\ -@var{h} is destroyed. If the graphics handle is invalid, the function\n\ +@var{h} is destroyed. If the graphics handle is invalid, the function\n\ returns immediately.\n\ \n\ In the second form, execution is suspended until the graphics object is\n\ -destroyed or the property named @var{prop} is modified. If the graphics\n\ +destroyed or the property named @var{prop} is modified. If the graphics\n\ handle is invalid or the property does not exist, the function returns\n\ immediately.\n\ \n\ In the third form, execution is suspended until the graphics object is\n\ -destroyed or the property named @var{prop} is set to @var{value}. The\n\ -function @code{isequal} is used to compare property values. If the graphics\n\ +destroyed or the property named @var{prop} is set to @var{value}. The\n\ +function @code{isequal} is used to compare property values. If the graphics\n\ handle is invalid, the property does not exist or the property is already\n\ set to @var{value}, the function returns immediately.\n\ \n\ An optional timeout can be specified using the property @code{timeout}.\n\ This timeout value is the number of seconds to wait for the condition to be\n\ -true. @var{timeout} must be at least 1. If a smaller value is specified, a\n\ -warning is issued and a value of 1 is used instead. If the timeout value is\n\ +true. @var{timeout} must be at least 1. If a smaller value is specified, a\n\ +warning is issued and a value of 1 is used instead. If the timeout value is\n\ not an integer, it is truncated towards 0.\n\ \n\ To define a condition on a property named @code{timeout}, use the string\n\
--- a/src/load-save.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/load-save.cc Wed Nov 23 08:38:19 2011 -0800 @@ -1475,6 +1475,7 @@ @table @code\n\ @item -append\n\ Append to the destination instead of overwriting.\n\ +\n\ @item -ascii\n\ Save a single matrix in a text file without header or any other information.\n\ \n\
--- a/src/mappers.cc Tue Nov 22 21:22:46 2011 -0800 +++ b/src/mappers.cc Wed Nov 23 08:38:19 2011 -0800 @@ -1565,7 +1565,7 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} round (@var{x})\n\ Return the integer nearest to @var{x}. If @var{x} is complex, return\n\ -@code{round (real (@var{x})) + round (imag (@var{x})) * I}. If there\n\ +@code{round (real (@var{x})) + round (imag (@var{x})) * I}. If there\n\ are two nearest integers, return the one further away from zero.\n\ \n\ @example\n\