Mercurial > octave-nkf
changeset 11563:3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
line wrap: on
line diff
--- a/scripts/ChangeLog Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/ChangeLog Tue Jan 18 20:55:01 2011 -0800 @@ -1,3 +1,24 @@ +2011-01-17 Rik <octave@nomad.inbox5.com> + + * audio/wavread.m, deprecated/spqr.m, elfun/lcm.m, general/bitget.m, + general/curl.m, general/divergence.m, general/interp3.m, + general/quadv.m, geometry/delaunayn.m, geometry/griddata.m, + help/help.m, io/textread.m, io/textscan.m, linear-algebra/cond.m, + miscellaneous/mkoctfile.m, miscellaneous/orderfields.m, + miscellaneous/run.m, miscellaneous/setappdata.m, plot/axis.m, + plot/caxis.m, plot/daspect.m, plot/ellipsoid.m, plot/errorbar.m, + plot/gnuplot_binary.in, plot/hist.m, plot/hold.m, plot/ishold.m, + plot/legend.m, plot/mesh.m, plot/pbaspect.m, plot/pie3.m, plot/print.m, + plot/private/__add_default_menu__.m, plot/scatter.m, plot/scatter3.m, + plot/shg.m, plot/slice.m, plot/surf.m, plot/surfl.m, plot/uigetdir.m, + plot/uigetfile.m, plot/uimenu.m, plot/uiputfile.m, plot/view.m, + set/unique.m, signal/periodogram.m, sparse/pcg.m, sparse/pcr.m, + sparse/spfun.m, specfun/legendre.m, + statistics/distributions/poisspdf.m, statistics/distributions/wblpdf.m, + strings/strjust.m, strings/untabify.m, testfun/assert.m, + testfun/demo.m, testfun/example.m, testfun/fail.m, testfun/test.m: + Grammarcheck m-files for 3.4 release. + 2011-01-17 Rik <octave@nomad.inbox5.com> * general/dblquad.m, general/quadgk.m, general/quadl.m,
--- a/scripts/audio/wavread.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/audio/wavread.m Tue Jan 18 20:55:01 2011 -0800 @@ -29,7 +29,7 @@ ## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n}) ## Read only the first @var{n} samples from each channel. ## -## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, [@var{n1} @var{n2}]) +## @deftypefnx {Function File} {[@dots{}] =} wavread (@var{filename}, @var{n1} @var{n2}) ## Read only samples @var{n1} through @var{n2} from each channel. ## ## @deftypefnx {Function File} {[@var{samples}, @var{channels}] =} wavread (@var{filename}, "size")
--- a/scripts/deprecated/spqr.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/deprecated/spqr.m Tue Jan 18 20:55:01 2011 -0800 @@ -18,9 +18,9 @@ ## -*- texinfo -*- ## @deftypefn {Loadable Function} {@var{r} =} spqr (@var{a}) -## @deftypefnx {Loadable Function} {@var{r} =} spqr (@var{a},0) -## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a},@var{b}) -## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a},@var{b},0) +## @deftypefnx {Loadable Function} {@var{r} =} spqr (@var{a}, 0) +## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a}, @var{b}) +## @deftypefnx {Loadable Function} {[@var{c}, @var{r}] =} spqr (@var{a}, @var{b}, 0) ## This function has been deprecated. Use @code{qr} instead. ## @end deftypefn
--- a/scripts/elfun/lcm.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/elfun/lcm.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,7 +20,8 @@ ## @deftypefn {Mapping Function} {} lcm (@var{x}, @var{y}) ## @deftypefnx {Mapping Function} {} lcm (@var{x}, @var{y}, @dots{}) ## Compute the least common multiple of @var{x} and @var{y}, -## or of the list of all arguments. All elements must be the same size or scalar. +## or of the list of all arguments. All elements must be the same size or +## scalar. ## @seealso{factor, gcd} ## @end deftypefn
--- a/scripts/general/bitget.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/general/bitget.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{c} =} bitget (@var{A},@var{n}) +## @deftypefn {Function File} {@var{c} =} bitget (@var{A}, @var{n}) ## Return the status of bit(s) @var{n} of unsigned integers in @var{A} ## the lowest significant bit is @var{n} = 1. ##
--- a/scripts/general/curl.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/general/curl.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,19 +17,18 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{cx}, @var{cy}, @var{cz}, @var{v}] =} curl (@var{x}, @var{y}, @var{z}, @var{fx}, @var{fy}, @var{fz}) +## @deftypefn {Function File} {[@var{cx}, @var{cy}, @var{cz}, @var{v}] =} curl (@var{x}, @var{y}, @var{z}, @var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {[@var{cz}, @var{v}] =} curl (@var{x}, @var{y}, @var{fx}, @var{fy}) ## @deftypefnx {Function File} {[@dots{}] =} curl (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {[@dots{}] =} curl (@var{fx}, @var{fy}) ## @deftypefnx {Function File} {@var{v} =} curl (@dots{}) -## Calculate curl of vector field given by the arrays @var{fx}, @var{fy}, and @var{fz} -## or @var{fx}, @var{fy} respectively. -## @iftex +## Calculate curl of vector field given by the arrays @var{fx}, @var{fy}, and +## @var{fz} or @var{fx}, @var{fy} respectively. ## @tex ## $$ curl F(x,y,z) = \left( {\partial{d} \over \partial{y}} F_z - {\partial{d} \over \partial{z}} F_y, {\partial{d} \over \partial{z}} F_x - {\partial{d} \over \partial{x}} F_z, {\partial{d} \over \partial{x}} F_y - {\partial{d} \over \partial{y}} F_x \right)$$ ## @end tex -## @end iftex ## @ifnottex +## ## @example ## @group ## / d d d d d d \ @@ -37,11 +36,12 @@ ## \ dy dz dz dx dx dy / ## @end group ## @end example +## ## @end ifnottex -## The coordinates of the vector field can be given by the arguments @var{x}, @var{y}, @var{z} -## or @var{x}, @var{y} respectively. -## @var{v} calculates the scalar component of the angular velocity vector in direction -## of the z-axis for two-dimensional input. For three-dimensional input the scalar +## The coordinates of the vector field can be given by the arguments @var{x}, +## @var{y}, @var{z} or @var{x}, @var{y} respectively. @var{v} calculates the +## scalar component of the angular velocity vector in direction of the z-axis +## for two-dimensional input. For three-dimensional input the scalar ## rotation is calculated at each grid point in direction of the vector field ## at that point. ## @seealso{divergence, gradient, del2}
--- a/scripts/general/divergence.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/general/divergence.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,19 +17,19 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{div} =} divergence (@var{x}, @var{y}, @var{z}, @var{fx}, @var{fy}, @var{fz}) +## @deftypefn {Function File} {@var{div} =} divergence (@var{x}, @var{y}, @var{z}, @var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {@var{div} =} divergence (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {@var{div} =} divergence (@var{x}, @var{y}, @var{fx}, @var{fy}) ## @deftypefnx {Function File} {@var{div} =} divergence (@var{fx}, @var{fy}) -## Calculate divegence of vector field given by the arrays @var{fx}, @var{fy}, and @var{fz} or @var{fx}, @var{fy} respectively. -## @iftex +## Calculate divegence of vector field given by the arrays @var{fx}, +## @var{fy}, and @var{fz} or @var{fx}, @var{fy} respectively. ## @tex ## $$ ## div F(x,y,z) = \partial_x{F} + \partial_y{F} + \partial_z{F} ## $$ ## @end tex -## @end iftex ## @ifnottex +## ## @example ## @group ## d d d @@ -37,9 +37,10 @@ ## dx dy dz ## @end group ## @end example +## ## @end ifnottex -## The coordinates of the vector field can be given by the arguments @var{x}, @var{y}, @var{z} -## or @var{x}, @var{y} respectively. +## The coordinates of the vector field can be given by the arguments @var{x}, +## @var{y}, @var{z} or @var{x}, @var{y} respectively. ## ## @seealso{curl, gradient, del2} ## @end deftypefn
--- a/scripts/general/interp3.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/general/interp3.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{vi} =} interp3 (@var{x}, @var{y},@var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi}) +## @deftypefn {Function File} {@var{vi} =} interp3 (@var{x}, @var{y}, @var{z}, @var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v}, @var{m}) ## @deftypefnx {Function File} {@var{vi} =} interp3 (@var{v})
--- a/scripts/general/quadv.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/general/quadv.m Tue Jan 18 20:55:01 2011 -0800 @@ -33,16 +33,17 @@ ## the adaptation procedure, otherwise the default value of 1e-6 is used. ## ## The algorithm used by @code{quadv}, involves recursively subdividing the -## integration interval and applying Simpson's rule on each sub-interval. -## If @var{trace} is @var{true}, after computing each of these partial integrals, -## display the total number of function evaluations, the left end of the sub-interval, -## the length of the sub-interval and the approximation of the integral over the sub-interval. +## integration interval and applying Simpson's rule on each sub-interval. +## If @var{trace} is @var{true}, after computing each of these partial +## integrals, display the total number of function evaluations, the left end +## of the sub-interval, the length of the sub-interval and the approximation +## of the integral over the sub-interval. ## ## Additional arguments @var{p1}, etc., are passed directly to @var{f}. ## To use default values for @var{tol} and @var{trace}, one may pass ## empty matrices. ## -##@seealso{quad,quadl,quadgk,quadcc,trapz,dblquad,triplequad} +##@seealso{quad, quadl, quadgk, quadcc, trapz, dblquad, triplequad} ## @end deftypefn function [q, fcnt] = quadv (f, a, b, tol, trace, varargin)
--- a/scripts/geometry/delaunayn.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/geometry/delaunayn.m Tue Jan 18 20:55:01 2011 -0800 @@ -27,7 +27,7 @@ ## points in a space of dimension dim. The return matrix @var{t} has the ## size @code{[m, dim+1]}. It contains for each row a set of indices to ## the points, which describes a simplex of dimension dim. For example, -## a 2d simplex is a triangle and 3d simplex is a tetrahedron. +## a 2-D simplex is a triangle and 3-D simplex is a tetrahedron. ## ## Extra options for the underlying Qhull command can be specified by the ## second argument. This argument is a cell array of strings. The default
--- a/scripts/geometry/griddata.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/geometry/griddata.m Tue Jan 18 20:55:01 2011 -0800 @@ -26,7 +26,7 @@ ## or @code{@var{x}, @var{y}} are vectors and @code{@var{z}} is matrix. ## ## The interpolation points are all @code{(@var{xi}, @var{yi})}. If -## @var{xi}, @var{yi} are vectors then they are made into a 2D mesh. +## @var{xi}, @var{yi} are vectors then they are made into a 2-D mesh. ## ## The interpolation method can be @code{"nearest"}, @code{"cubic"} or ## @code{"linear"}. If method is omitted it defaults to @code{"linear"}.
--- a/scripts/help/help.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/help/help.m Tue Jan 18 20:55:01 2011 -0800 @@ -1,4 +1,4 @@ -## Copyright (C) 2009-2011 Søren Hauberg +## Copyright (C) 2009-2011 S�ren Hauberg ## ## This file is part of Octave. ## @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} help @var{name} +## @deftypefn {Command} {} help @var{name} ## Display the help text for @var{name}. ## If invoked without any arguments, @code{help} displays instructions ## on how to access help from the command line.
--- a/scripts/io/textread.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/io/textread.m Tue Jan 18 20:55:01 2011 -0800 @@ -19,8 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}) ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}) -## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}, @ -## @var{prop1}, @var{value1}, @dots{}) +## @deftypefnx {Function File} {[@var{a}, @dots{}] =} textread (@var{filename}, @var{format}, @var{prop1}, @var{value1}, @dots{}) ## Read data from a text file. ## ## The file @var{filename} is read and parsed according to @var{format}. The
--- a/scripts/io/textscan.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/io/textscan.m Tue Jan 18 20:55:01 2011 -0800 @@ -28,11 +28,11 @@ ## @deftypefnx {Function File} {[@var{C}, @var{position}] =} textscan (@dots{}) ## Read data from a text file. ## -## The file associated with @var{fid} is read and parsed according to @var{format}. -## The function behaves like @code{strread} except it works by parsing a file -## instead of a string. See the documentation of @code{strread} for details. -## In addition to the options supported by @code{strread}, this function -## supports one more: +## The file associated with @var{fid} is read and parsed according to +## @var{format}. The function behaves like @code{strread} except it works by +## parsing a file instead of a string. See the documentation of +## @code{strread} for details. In addition to the options supported by +## @code{strread}, this function supports one more: ## @itemize ## @item "headerlines": ## @end itemize
--- a/scripts/linear-algebra/cond.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/linear-algebra/cond.m Tue Jan 18 20:55:01 2011 -0800 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} cond (@var{A}) -## @deftypefnx {Function File} {} cond (@var{A},@var{p}) +## @deftypefnx {Function File} {} cond (@var{A}, @var{p}) ## Compute the @var{p}-norm condition number of a matrix. @code{cond ## (@var{A})} is ## defined as
--- a/scripts/miscellaneous/mkoctfile.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/miscellaneous/mkoctfile.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} mkoctfile [-options] file @dots{} +## @deftypefn {Command} {} mkoctfile [-options] file @dots{} ## ## The @code{mkoctfile} function compiles source code written in C, ## C++, or Fortran. Depending on the options used with @code{mkoctfile}, the
--- a/scripts/miscellaneous/orderfields.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/miscellaneous/orderfields.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{t}, @var{p}] =} orderfields (@var{s1}[, @var{s2}]) +## @deftypefn {Function File} {[@var{t}, @var{p}] =} orderfields (@var{s1}) +## @deftypefnx {Function File} {[@var{t}, @var{p}] =} orderfields (@var{s1}, @var{s2}) ## Return a copy of @var{s1} with fields arranged alphabetically or ## as specified by @var{s2}. ## @@ -35,7 +36,6 @@ ## Examples: ## ## @example -## @group ## s = struct("d", 4, "b", 2, "a", 1, "c", 3); ## t1 = orderfields(s) ## @result{} t1 = @@ -80,7 +80,6 @@ ## 4 ## 2 ## 3 -## @end group ## @end example ## ## @seealso{getfield, rmfield, isfield, isstruct, fieldnames, struct}
--- a/scripts/miscellaneous/run.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/miscellaneous/run.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,9 +20,10 @@ ## @deftypefn {Command} {} run @var{script} ## @deftypefnx {Function File} {} run (@var{script}) ## Run scripts in the current workspace that are not necessarily on the -## path. If @var{script} is the script to run, including its path, then @code{run} -## changes the directory to the directory where @var{script} is found. @code{run} -## then executes the script, and returns to the original directory. +## path. If @var{script} is the script to run, including its path, then +## @code{run} changes the directory to the directory where @var{script} is +## found. @code{run} then executes the script, and returns to the original +## directory. ## @seealso{system} ## @end deftypefn
--- a/scripts/miscellaneous/setappdata.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/miscellaneous/setappdata.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} setappdata (@var{h}, @var{name}, @var{value}) ## Sets the named application data to @var{value} for the object(s) with -## handle(s) @var{h}. If the application data with the specified name does +## handle(s) @var{h}. If the application data with the specified name does ## not exist, it is created. ## @end deftypefn
--- a/scripts/plot/axis.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/axis.m Tue Jan 18 20:55:01 2011 -0800 @@ -27,9 +27,9 @@ ## @deftypefnx {Function File} {@var{limits} =} axis () ## Set axis limits for plots. ## -## The argument @var{limits} should be a 2, 4, or 6 element vector. The -## first and second elements specify the lower and upper limits for the x -## axis. The third and fourth specify the limits for the y-axis, and the +## The argument @var{limits} should be a 2-, 4-, or 6-element vector. The +## first and second elements specify the lower and upper limits for the +## x-axis. The third and fourth specify the limits for the y-axis, and the ## fifth and sixth specify the limits for the z-axis. ## ## Without any arguments, @code{axis} turns autoscaling on. @@ -48,7 +48,7 @@ ## forces a square aspect ratio, and ## ## @example -## axis ("labely", "tic"); +## axis ("tic", "labely"); ## @end example ## ## @noindent @@ -58,7 +58,7 @@ ## @noindent ## The following options control the aspect ratio of the axes. ## -## @table @code +## @table @asis ## @item "square" ## Force a square aspect ratio. ## @@ -72,7 +72,7 @@ ## @noindent ## The following options control the way axis limits are interpreted. ## -## @table @code +## @table @asis ## @item "auto" ## Set the specified axes to have nice limits around the data ## or all if no axes are specified. @@ -91,7 +91,7 @@ ## @noindent ## The following options affect the appearance of tic marks. ## -## @table @code +## @table @asis ## @item "on" ## Turn tic marks and labels on for all axes. ## @@ -115,7 +115,7 @@ ## The following options affect the direction of increasing values on ## the axes. ## -## @table @code +## @table @asis ## @item "ij" ## Reverse y-axis, so lower values are nearer the top. ##
--- a/scripts/plot/caxis.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/caxis.m Tue Jan 18 20:55:01 2011 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} caxis (@var{h}, @dots{}) ## Set color axis limits for plots. ## -## The argument @var{limits} should be a 2 element vector specifying the +## The argument @var{limits} should be a 2-element vector specifying the ## lower and upper limits to assign to the first and last value in the ## colormap. Values outside this range are clamped to the first and last ## colormap entries.
--- a/scripts/plot/daspect.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/daspect.m Tue Jan 18 20:55:01 2011 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) ## Set the data aspect ratio of the current axes. The aspect ratio is -## a normalized 3 element vector representing the span of the x, y, and +## a normalized 3-element vector representing the span of the x, y, and ## z-axes limits. ## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( ) ## Return the data aspect ratio of the current axes.
--- a/scripts/plot/ellipsoid.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/ellipsoid.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} ellipsoid (@var{xc},@var{yc}, @var{zc}, @var{xr}, @var{yr}, @var{zr}, @var{n}) +## @deftypefn {Function File} {[@var{x}, @var{y}, @var{z}] =} ellipsoid (@var{xc}, @var{yc}, @var{zc}, @var{xr}, @var{yr}, @var{zr}, @var{n}) ## @deftypefnx {Function File} {} ellipsoid (@var{h}, @dots{}) ## Generate three matrices in @code{meshgrid} format that define an ## ellipsoid. Called with no return arguments, @code{ellipsoid} calls
--- a/scripts/plot/errorbar.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/errorbar.m Tue Jan 18 20:55:01 2011 -0800 @@ -51,7 +51,7 @@ ## If @var{fmt} is missing, yerrorbars ("~") plot style is assumed. ## ## If the @var{fmt} argument is supplied, it is interpreted as in -## normal plots. In addition, @var{fmt} may include an errorbar style +## normal plots. In addition, @var{fmt} may include an errorbar style ## which must preceed the line and marker format. The following plot ## styles are supported by errorbar: ##
--- a/scripts/plot/gnuplot_binary.in Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/gnuplot_binary.in Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Loadable Function} {[@var{prog}, @var{args}] =} gnuplot_binary () +## @deftypefn {Loadable Function} {[@var{prog}, @var{args}] =} gnuplot_binary () ## @deftypefnx {Loadable Function} {[@var{old_prog}, @var{old_args}] =} gnuplot_binary (@var{new_prog}, @var{arg1}, @dots{}) ## Query or set the name of the program invoked by the plot command ## and any arguments to pass to it. Previous arguments are returned
--- a/scripts/plot/hist.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/hist.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} hist (@var{y}) +## @deftypefn {Function File} {} hist (@var{y}) ## @deftypefnx {Function File} {} hist (@var{y}, @var{x}) ## @deftypefnx {Function File} {} hist (@var{y}, @var{nbins}) ## @deftypefnx {Function File} {} hist (@var{y}, @var{x}, @var{norm}) @@ -46,7 +46,7 @@ ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram. ## ## The histogram's appearance may be modified by specifying property/value -## pairs, @var{prop} and @var{val} pairs. For example the face and edge +## pairs, @var{prop} and @var{val} pairs. For example the face and edge ## color may be modified. ## ## @example
--- a/scripts/plot/hold.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/hold.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} hold -## @deftypefnx {Function File} {} hold @var{state} +## @deftypefn {Command} {} hold +## @deftypefnx {Command} {} hold @var{state} ## @deftypefnx {Function File} {} hold (@var{hax}, @dots{}) ## Toggle or set the 'hold' state of the plotting engine which determines ## whether new graphic objects are added to the plot or replace the existing
--- a/scripts/plot/ishold.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/ishold.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} ishold +## @deftypefn {Command} {} ishold ## Return true if the next plot will be added to the current plot, or ## false if the plot device will be cleared before drawing the next plot. ## @seealso{hold}
--- a/scripts/plot/legend.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/legend.m Tue Jan 18 20:55:01 2011 -0800 @@ -71,7 +71,7 @@ ## @end multitable ## ## The optional parameter @var{orient} determines if the key elements -## are placed vertically or horizontally. The allowed values are "vertical" +## are placed vertically or horizontally. The allowed values are "vertical" ## or "horizontal" with the default being "vertical". ## ## The following customizations are available using @var{option}:
--- a/scripts/plot/mesh.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/mesh.m Tue Jan 18 20:55:01 2011 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} mesh (@var{z}) ## @deftypefnx {Function File} {} mesh (@dots{}, @var{c}) ## @deftypefnx {Function File} {} mesh (@var{hax}, @dots{}) -## @deftypefnx {Function File} {@var{h} = } mesh (@dots{}) +## @deftypefnx {Function File} {@var{h} =} mesh (@dots{}) ## Plot a mesh given matrices @var{x}, and @var{y} from @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex @@ -30,8 +30,8 @@ ## to different @var{y} values. ## ## The color of the mesh is derirved from the @code{colormap} -## and the value of @var{z}. Optionally the color of the mesh can be -## specified independent of of @var{z}, by adding a fourth matrix, @var{c}. +## and the value of @var{z}. Optionally the color of the mesh can be +## specified independent of @var{z}, by adding a fourth matrix, @var{c}. ## @seealso{colormap, contour, meshgrid, surf} ## @end deftypefn
--- a/scripts/plot/pbaspect.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/pbaspect.m Tue Jan 18 20:55:01 2011 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} pbaspect (@var{plot_box_aspect_ratio}) ## Set the plot box aspect ratio of the current axes. The aspect ratio -## is a normalized 3 element vector representing the rendered lengths of +## is a normalized 3-element vector representing the rendered lengths of ## the x, y, and z-axes. ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) ## Return the plot box aspect ratio of the current axes.
--- a/scripts/plot/pie3.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/pie3.m Tue Jan 18 20:55:01 2011 -0800 @@ -23,9 +23,9 @@ ## @deftypefnx {Function File} {} pie3 (@dots{}, @var{labels}) ## @deftypefnx {Function File} {} pie3 (@var{h}, @dots{}); ## @deftypefnx {Function File} {@var{h} =} pie3 (@dots{}); -## Drawa a 3D pie chart. +## Draw a a 3-D pie chart. ## -## Called with a single vector argument, produces a 3D pie chart of the +## Called with a single vector argument, produces a 3-D pie chart of the ## elements in @var{x}, with the size of the slice determined by percentage ## size of the values of @var{x}. ## @@ -80,4 +80,4 @@ %! pie3 ([0.17, 0.34, 0.41], {"Cheddar", "Swiss", "Camembert"}); %! colormap([1,0,0;0,1,0;0,0,1;1,1,0;1,0,1;0,1,1]); %! axis ([-2,2,-2,2]); -%! title ("missing slice"); \ No newline at end of file +%! title ("missing slice");
--- a/scripts/plot/print.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/print.m Tue Jan 18 20:55:01 2011 -0800 @@ -35,7 +35,7 @@ ## ## @table @code ## @item -f@var{h} -## Specify the handle, @var{h}, of the figure to be printed. The +## Specify the handle, @var{h}, of the figure to be printed. The ## default is the current figure. ## ## @item -P@var{printer} @@ -56,10 +56,10 @@ ## ## @item -portrait ## @itemx -landscape -## Specify the orientation of the plot for printed output. For +## Specify the orientation of the plot for printed output. For ## non-printed output the aspect ratio of the output corresponds to ## the plot area defined by the "paperposition" property in the -## orientation specified. This options is equivalent to changing +## orientation specified. This options is equivalent to changing ## the figure's "paperorientation" property. ## ## @item -d@var{device} @@ -69,15 +69,15 @@ ## @itemx ps2 ## @itemx psc ## @itemx psc2 -## Postscript (level 1 and 2, mono and color). The FLTK backend +## Postscript (level 1 and 2, mono and color). The FLTK backend ## generates Postscript level 3.0. ## ## @item eps ## @itemx eps2 ## @itemx epsc ## @itemx epsc2 -## Encapsulated postscript (level 1 and 2, mono and color). The FLTK backend -## generates Postscript level 3.0. +## Encapsulated postscript (level 1 and 2, mono and color). The FLTK +## backend generates Postscript level 3.0. ## ## @item tex ## @itemx epslatex @@ -89,11 +89,11 @@ ## for graphics. The file produced by @code{epslatexstandalone} can be ## processed directly by @LaTeX{}. The other formats are intended to ## be included in a @LaTeX{} (or @TeX{}) document. The @code{tex} device -## is the same as the @code{epslatex} device. The @code{pdflatex} device +## is the same as the @code{epslatex} device. The @code{pdflatex} device ## is only available for the FLTK backend. ## ## @item tikz -## Generate a @LaTeX{} file using PGF/TikZ. For the FLTK the result is +## Generate a @LaTeX{} file using PGF/TikZ@. For the FLTK the result is ## PGF. ## ## @item ill @@ -197,11 +197,11 @@ ## Forces a tight bounding box for eps-files. ## ## @item -@var{preview} -## Adds a preview to eps-files. Supported formats are; +## Adds a preview to eps-files. Supported formats are; ## ## @table @code ## @item -interchange -## Provides a interchange preview. +## Provides an interchange preview. ## ## @item -metalfile ## Provides a metafile preview. @@ -214,10 +214,10 @@ ## @end table ## ## @item -S@var{xsize},@var{ysize} -## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG. For +## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG@. For ## PS, EPS, PDF, and other vector formats the plot size is in points. ## This option is equivalent to changing the size of the plot box -## associated with "paperposition" property. Using the command form of +## associated with "paperposition" property. Using the command form of ## the print function, you must quote the @var{xsize},@var{ysize} ## option. For example, by writing @w{@code{"-S640,480"}}. ## @@ -233,19 +233,23 @@ ## Example: Print to a file, using the svg device. ## ## @example +## @group ## figure (1) ## clf () ## surf (peaks) ## print -dsvg figure1.svg +## @end group ## @end example ## ## Example: Print to an HP Deskjet 550C. ## ## @example +## @group ## figure (1) ## clf () ## surf (peaks) ## print -dcdj550 +## @end group ## @end example ## ## @seealso{figure, orient, saveas}
--- a/scripts/plot/private/__add_default_menu__.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/private/__add_default_menu__.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} __add_default_menu__ (@var{fig}) -## Adds default menu to figure. All uimenu handles have +## @deftypefn {Function File} {} __add_default_menu__ (@var{fig}) +## Adds default menu to figure. All uimenu handles have ## set their property "handlevisibility" to "off". ## @end deftypefn
--- a/scripts/plot/scatter.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/scatter.m Tue Jan 18 20:55:01 2011 -0800 @@ -34,9 +34,9 @@ ## given or is an empty matrix, then the default value of 8 points is used. ## ## The color of the markers is determined by @var{c}, which can be a string -## defining a fixed color, a 3 element vector giving the red, green and blue -## components of the color, a vector of the same length as @var{x} that gives -## a scaled index into the current colormap, or a @var{n}-by-3 matrix defining +## defining a fixed color; a 3-element vector giving the red, green,and blue +## components of the color; a vector of the same length as @var{x} that gives +## a scaled index into the current colormap; or a @var{n}-by-3 matrix defining ## the colors of each of the markers individually. ## ## The marker to use can be changed with the @var{style} argument, that is a
--- a/scripts/plot/scatter3.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/scatter3.m Tue Jan 18 20:55:01 2011 -0800 @@ -31,9 +31,9 @@ ## not given or is an empty matrix, then the default value of 8 points is used. ## ## The color of the markers is determined by @var{c}, which can be a string -## defining a fixed color, a 3 element vector giving the red, green and blue -## components of the color, a vector of the same length as @var{x} that gives -## a scaled index into the current colormap, or a @var{n}-by-3 matrix defining +## defining a fixed color; a 3-element vector giving the red, green, and blue +## components of the color; a vector of the same length as @var{x} that gives +## a scaled index into the current colormap; or a @var{n}-by-3 matrix defining ## the colors of each of the markers individually. ## ## The marker to use can be changed with the @var{style} argument, that is a
--- a/scripts/plot/shg.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/shg.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} shg +## @deftypefn {Command} {} shg ## Show the graph window. Currently, this is the same as executing ## @code{drawnow}. ## @seealso{drawnow, figure}
--- a/scripts/plot/slice.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/slice.m Tue Jan 18 20:55:01 2011 -0800 @@ -23,7 +23,7 @@ ## @deftypefnx {Function File} {} slice (@var{v}, @var{xi}, @var{yi}, @var{zi}) ## @deftypefnx {Function File} {@var{h} =} slice (@dots{}) ## @deftypefnx {Function File} {@var{h} =} slice (@dots{}, @var{method}) -## Plot slices of 3D data/scalar fields. Each element of the 3-dimensional +## Plot slices of 3-D data/scalar fields. Each element of the 3-dimensional ## array @var{v} represents a scalar value at a location given by the ## parameters @var{x}, @var{y}, and @var{z}. The parameters @var{x}, ## @var{x}, and @var{z} are either 3-dimensional arrays of the same size
--- a/scripts/plot/surf.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/surf.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,11 +17,11 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} surf (@var{x}, @var{y}, @var{z}) +## @deftypefn {Function File} {} surf (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} surf (@var{z}) ## @deftypefnx {Function File} {} surf (@dots{}, @var{c}) ## @deftypefnx {Function File} {} surf (@var{hax}, @dots{}) -## @deftypefnx {Function File} {@var{h} = } surf (@dots{}) +## @deftypefnx {Function File} {@var{h} =} surf (@dots{}) ## Plot a surface given matrices @var{x}, and @var{y} from @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex @@ -30,8 +30,8 @@ ## to different @var{y} values. ## ## The color of the surface is derirved from the @code{colormap} and -## the value of @var{z}. Optionally the color of the surface can be -## specified independent of of @var{z}, by adding a fourth matrix, @var{c}. +## the value of @var{z}. Optionally the color of the surface can be +## specified independent of @var{z}, by adding a fourth matrix, @var{c}. ## @seealso{colormap, contour, meshgrid, mesh} ## @end deftypefn
--- a/scripts/plot/surfl.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/surfl.m Tue Jan 18 20:55:01 2011 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} surfl (@var{z}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P}) -## @deftypefnx {Function File} {} surfl (@dots{},"light") +## @deftypefnx {Function File} {} surfl (@dots{}, "light") ## Plot a lighted surface given matrices @var{x}, and @var{y} from ## @code{meshgrid} and ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of
--- a/scripts/plot/uigetdir.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/uigetdir.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,9 +20,9 @@ ## @deftypefn {Function File} {@var{dirname} =} uigetdir () ## @deftypefnx {Function File} {@var{dirname} =} uigetdir (@var{init_path}) ## @deftypefnx {Function File} {@var{dirname} =} uigetdir (@var{init_path}, @var{dialog_name}) -## Open a GUI dialog to select a directory. If @var{init_path} is not given -## the current working directory is used. @var{dialog_name} optionally be used to -## customize the dialog title. +## Open a GUI dialog to select a directory. If @var{init_path} is not given +## the current working directory is used. @var{dialog_name} optionally be +## used to customize the dialog title. ## @end deftypefn ## Author: Kai Habel
--- a/scripts/plot/uigetfile.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/uigetfile.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,43 +17,45 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uigetfile (@var{flt}) -## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}, @var{default_file}) +## @deftypefn {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uigetfile (@var{flt}) +## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}, @var{default_file}) ## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@var{flt}, @var{dialog_name}) -## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{},"Position",[@var{px}, @var{py}]) -## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{},"Multiselect",@var{mode}) +## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "Position", [@var{px}, @var{py}]) +## @deftypefnx {Function File} {[@dots{}] =} uigetfile (@dots{}, "Multiselect", @var{mode}) ## -## Open a GUI dialog to select a file. It returns the filename @var{fname}, -## the path to this file @var{fpath} and the filter index @var{fltidx}. +## Open a GUI dialog to select a file. It returns the filename @var{fname}, +## the path to this file @var{fpath}, and the filter index @var{fltidx}. ## @var{flt} contains a (list of) file filter string(s) in one of the following ## formats: ## -## @table @code +## @table @asis ## @item "/path/to/filename.ext" ## If a filename is given the file extension is extracted and used as filter. ## In addtion the path is selected as current path and the filname is selected ## as default file. -## Example: uigetfile("myfun.m"); +## Example: @code{uigetfile ("myfun.m")} ## -## @item A single file extension "*.ext". -## Example: uigetfile("*.ext"); +## @item A single file extension "*.ext" +## Example: @code{uigetfile ("*.ext")} ## -## @item A 2-column cell array, -## containing the file extension in the 1st column and a brief description -## in the 2nd column. -## Example: uigetfile(@{"*.ext","My Description";"*.xyz","XYZ-Format"@}); +## @item A 2-column cell array +## containing the file extension in the first column and a brief description +## in the second column. +## Example: @code{uigetfile (@{"*.ext", "My Description";"*.xyz", +## "XYZ-Format"@})} ## ## The filter string can also contain a semicolon separated list of filter ## extensions. -## Example: uigetfile(@{"*.gif;*.png;*.jpg", "Supported Picture Formats"@}); +## Example: @code{uigetfile (@{"*.gif;*.png;*.jpg", "Supported Picture +## Formats"@})} ## @end table ## ## @var{dialog_name} can be used to customize the dialog title. ## If @var{default_file} is given it is selected in the GUI dialog. ## If in addtion a path is given it is also used as current path. ## -## The screen position of the GUI dialog can be set by using the "Position" key -## and a 2-valued vector containing the pixel coordinates. +## The screen position of the GUI dialog can be set using the "Position" key +## and a 2-element vector containing the pixel coordinates. ## Two or more files can be selected when setting the "Multiselect" key to "on". ## In that case @var{fname} is a cell array containing the files. ## @end deftypefn
--- a/scripts/plot/uimenu.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/uimenu.m Tue Jan 18 20:55:01 2011 -0800 @@ -19,44 +19,44 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} uimenu (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {} uimenu (@var{h}, @var{property}, @var{value}, @dots{}) -## Create an uimenu object and return a handle to it. If @var{h} is ommited then -## a top level menu entry for the current figure is created. If @var{h} is given then a -## submenu relative to @var{h} is created. +## Create an uimenu object and return a handle to it. If @var{h} is ommited +## then a top level menu entry for the current figure is created. If @var{h} +## is given then a submenu relative to @var{h} is created. ## ## Uimenu objects have the following specific properties: ## ## @table @code ## @item "accelerator" ## A string containg the key combination together with CTRL to execute this -## menu entry (e.g. "x" for CTRL+x). +## menu entry (e.g., "x" for CTRL+x). ## ## @item "callback" -## Is the function called when this menu entry is executed. It can be either a -## function string (e.g. "myfun"), a function handle (e.g. @@myfun) or a cell +## Is the function called when this menu entry is executed. It can be either a +## function string (e.g., "myfun"), a function handle (e.g., @@myfun) or a cell ## array containing the function handle and arguments for the callback -## function (e.g. @{@@myfun, arg1, arg2@}). +## function (e.g., @{@@myfun, arg1, arg2@}). ## ## @item "checked" -## Can be set "on" or "off". Sets a mark at this menu entry. +## Can be set "on" or "off". Sets a mark at this menu entry. ## ## @item "enable" -## Can be set "on" or "off". If disabled the menu entry cannot be selected and it is -## grayed out. +## Can be set "on" or "off". If disabled the menu entry cannot be selected +## and it is grayed out. ## ## @item "foregroundcolor" ## A color value setting the text color for this menu entry. ## ## @item "label" -## A string containing the label for this menu entry. A "&"-symbol can be used to mark -## the "accelerator" character (e.g. "E&xit") +## A string containing the label for this menu entry. A "&"-symbol can be +## used to mark the "accelerator" character (e.g., "E&xit") ## ## @item "position" -## An scalar value containing the relative menu position. The entry with the lowest -## value is at the first position starting from left or top. +## An scalar value containing the relative menu position. The entry with the +## lowest value is at the first position starting from left or top. ## ## @item "separator" -## Can be set "on" or "off". If enabled it draws a separator line above the current -## position. It is ignored for top level entries. +## Can be set "on" or "off". If enabled it draws a separator line above the +## current position. It is ignored for top level entries. ## ## ## @end table
--- a/scripts/plot/uiputfile.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/uiputfile.m Tue Jan 18 20:55:01 2011 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}, @var{dialog_name}) ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile (@var{flt}) ## @deftypefnx {Function File} {[@var{fname}, @var{fpath}, @var{fltidx}] =} uiputfile ()) -## Open a GUI dialog to select a file. @var{flt} contains a (list of) file +## Open a GUI dialog to select a file. @var{flt} contains a (list of) file ## filter string(s) in one of the following formats: ## ## @table @code
--- a/scripts/plot/view.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/plot/view.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,21 +17,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- +## @deftypefn {Function File} {[@var{azimuth}, @var{elevation}] =} view () ## @deftypefn {Function File} {} view (@var{azimuth}, @var{elevation}) -## @deftypefnx {Function File} {} view ([@var{azimuth}, @var{elevation}]) -## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}]) +## @deftypefnx {Function File} {} view ([@var{azimuth}, @var{elevation}]) +## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}]) ## @deftypefnx {Function File} {} view (@var{dims}) ## @deftypefnx {Function File} {} view (@var{ax}, @dots{}) -## @deftypefnx {Function File} {[@var{azimuth}, @var{elevation}] =} view () -## Set or get the viewpoint for the current axes. The parameters +## Query or set set the viewpoint for the current axes. The parameters ## @var{azimuth} and @var{elevation} can be given as two arguments or as ## 2-element vector. -## The viewpoint can also be given with cartesian coordinates @var{x}, +## The viewpoint can also be given with Cartesian coordinates @var{x}, ## @var{y}, and @var{z}. ## The call @code{view (2)} sets the viewpoint to @var{azimuth} = 0 -## and @var{elevation} = 90, which is default for 2d graphs. +## and @var{elevation} = 90, which is the default for 2-D graphs. ## The call @code{view (3)} sets the viewpoint to @var{azimuth} = -37.5 -## and @var{elevation} = 30, which is default for 3d graphs. +## and @var{elevation} = 30, which is the default for 3-D graphs. ## If @var{ax} is given, the viewpoint is set for this axes, otherwise ## it is set for the current axes. ## @end deftypefn
--- a/scripts/set/unique.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/set/unique.m Tue Jan 18 20:55:01 2011 -0800 @@ -24,7 +24,7 @@ ## @deftypefnx {Function File} {} unique (@dots{}, "last") ## @deftypefnx {Function File} {[@var{y}, @var{i}, @var{j}] =} unique (@dots{}) ## Return the unique elements of @var{x}, sorted in ascending order. -## If the input @var{x} is a vector then the output is a also a vector with the +## If the input @var{x} is a vector then the output is also a vector with the ## same orientation (row or column) as the input. For a matrix input the ## output is always a column vector. @var{x} may also be a cell array of ## strings.
--- a/scripts/signal/periodogram.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/signal/periodogram.m Tue Jan 18 20:55:01 2011 -0800 @@ -18,43 +18,41 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[Pxx,w] =} periodogram (@var{x}) +## @deftypefn {Function File} {[Pxx, @var{w}] =} periodogram (@var{x}) ## For a data matrix @var{x} from a sample of size @var{n}, return the -## periodogram. w returns the angular frequency. +## periodogram. The angular frequency is returned in @var{w}. ## -## [Pxx,w] = periodogram (@var{x}). +## [Pxx,w] = periodogram (@var{x}). ## -## [Pxx,w] = periodogram (@var{x},win). +## [Pxx,w] = periodogram (@var{x},win). ## -## [Pxx,w] = periodogram (@var{x},win,nfft). +## [Pxx,w] = periodogram (@var{x},win,nfft). ## -## [Pxx,f] = periodogram (@var{x},win,nfft,Fs). +## [Pxx,f] = periodogram (@var{x},win,nfft,Fs). ## -## [Pxx,f] = periodogram (@var{x},win,nfft,Fs,"range"). +## [Pxx,f] = periodogram (@var{x},win,nfft,Fs,"range"). ## -## @itemize -## @item x: data; if real-valued a one-sided spectrum is estimated, -## if complex-valued or range indicates "twosided", the full spectrum is estimated. +## @itemize +## @item x: data; if real-valued a one-sided spectrum is estimated, +## if complex-valued or range indicates "twosided", the full spectrum is estimated. ## -## @item win: weight data with window, x.*win is used for further computation, -## if window is empty, a rectangular window is used. +## @item win: weight data with window, x.*win is used for further computation, +## if window is empty, a rectangular window is used. ## -## @item nfft: number of frequency bins, default max(256, 2.^ceil(log2(length(x)))). +## @item nfft: number of frequency bins, default max(256, 2.^ceil(log2(length(x)))). ## -## @item Fs: sampleing rate, default 1. +## @item Fs: sampling rate, default 1. ## -## @item range: "onesided" computes spectrum from [0..nfft/2+1]. -## "twosided" computes spectrum from [0..nfft-1]. These strings can appear at any -## position in the list input arguments after window. -## -## @item Pxx: one-, or two-sided power spectrum. +## @item range: "onesided" computes spectrum from [0..nfft/2+1]. +## "twosided" computes spectrum from [0..nfft-1]. These strings can appear at any +## position in the list input arguments after window. ## -## @item w: angular frequency [0..2*pi) (two-sided) or [0..pi] one-sided. +## @item Pxx: one-, or two-sided power spectrum. ## -## @item f: frequency [0..Fs) (two-sided) or [0..Fs/2] one-sided. -## @end itemize +## @item w: angular frequency [0..2*pi) (two-sided) or [0..pi] one-sided. ## -## +## @item f: frequency [0..Fs) (two-sided) or [0..Fs/2] one-sided. +## @end itemize ## @end deftypefn ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
--- a/scripts/sparse/pcg.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/sparse/pcg.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {@var{x} =} pcg (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{m1}, @var{m2}, @var{x0}, @dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}, @var{eigest}] =} pcg (@dots{}) ## -## Solves the linear system of equations @code{@var{A} * @var{x} = -## @var{b}} by means of the Preconditioned Conjugate Gradient iterative +## Solves the linear system of equations @code{@var{A} * @var{x} = @var{b}} +## by means of the Preconditioned Conjugate Gradient iterative ## method. The input arguments are ## ## @itemize @@ -38,9 +38,10 @@ ## ## @item ## @var{tol} is the required relative tolerance for the residual error, -## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if @code{norm -## (@var{b} - @var{A} * @var{x}) <= @var{tol} * norm (@var{b} - @var{A} * -## @var{x0})}. If @var{tol} is empty or is omitted, the function sets +## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if +## @code{norm (@var{b} - @var{A} * @var{x}) <= +## @var{tol} * norm (@var{b} - @var{A} * @var{x0})}. +## If @var{tol} is empty or is omitted, the function sets ## @code{@var{tol} = 1e-6} by default. ## ## @item
--- a/scripts/sparse/pcr.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/sparse/pcr.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {@var{x} =} pcr (@var{A}, @var{b}, @var{tol}, @var{maxit}, @var{m}, @var{x0}, @dots{}) ## @deftypefnx {Function File} {[@var{x}, @var{flag}, @var{relres}, @var{iter}, @var{resvec}] =} pcr (@dots{}) ## -## Solves the linear system of equations @code{@var{A} * @var{x} = -## @var{b}} by means of the Preconditioned Conjugate Residuals iterative +## Solves the linear system of equations @code{@var{A} * @var{x} = @var{b}} +## by means of the Preconditioned Conjugate Residuals iterative ## method. The input arguments are ## ## @itemize @@ -38,9 +38,10 @@ ## ## @item ## @var{tol} is the required relative tolerance for the residual error, -## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if @code{norm -## (@var{b} - @var{A} * @var{x}) <= @var{tol} * norm (@var{b} - @var{A} * -## @var{x0})}. If @var{tol} is empty or is omitted, the function sets +## @code{@var{b} - @var{A} * @var{x}}. The iteration stops if +## @code{norm (@var{b} - @var{A} * @var{x}) <= +## @var{tol} * norm (@var{b} - @var{A} * @var{x0})}. +## If @var{tol} is empty or is omitted, the function sets ## @code{@var{tol} = 1e-6} by default. ## ## @item
--- a/scripts/sparse/spfun.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/sparse/spfun.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{y} =} spfun (@var{f},@var{S}) +## @deftypefn {Function File} {@var{y} =} spfun (@var{f}, @var{S}) ## Compute @code{f(@var{S})} for the non-zero values of @var{S}. ## This results in a sparse matrix with the same structure as ## @var{S}. The function @var{f} can be passed as a string, a
--- a/scripts/specfun/legendre.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/specfun/legendre.m Tue Jan 18 20:55:01 2011 -0800 @@ -39,6 +39,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## m m 2 m/2 d^m @@ -46,6 +47,7 @@ ## n dx^m n ## @end group ## @end example +## ## @end ifnottex ## ## @noindent @@ -57,6 +59,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## 1 d^n 2 n @@ -64,6 +67,7 @@ ## n 2^n n! dx^n ## @end group ## @end example +## ## @end ifnottex ## ## @noindent @@ -93,6 +97,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## 0 0 @@ -100,6 +105,7 @@ ## n n ## @end group ## @end example +## ## @end ifnottex ## ## For Legendre functions of degree n and order m: @@ -110,6 +116,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## m m m 2(n-m)! 0.5 @@ -117,6 +124,7 @@ ## n n (n+m)! ## @end group ## @end example +## ## @end ifnottex ## ## If the optional argument @var{normalization} is @code{"norm"}, @@ -132,6 +140,7 @@ ## $$ ## @end tex ## @ifnottex +## ## @example ## @group ## m m m (n+0.5)(n-m)! 0.5 @@ -139,6 +148,7 @@ ## n n (n+m)! ## @end group ## @end example +## ## @end ifnottex ## @end deftypefn
--- a/scripts/statistics/distributions/poisspdf.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/statistics/distributions/poisspdf.m Tue Jan 18 20:55:01 2011 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} poisspdf (@var{x}, @var{lambda}) ## For each element of @var{x}, compute the probability density function -## (PDF) at @var{x} of the poisson distribution with parameter @var{lambda}. +## (PDF) at @var{x} of the Poisson distribution with parameter @var{lambda}. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/statistics/distributions/wblpdf.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/statistics/distributions/wblpdf.m Tue Jan 18 20:55:01 2011 -0800 @@ -32,7 +32,7 @@ ## ## @end ifnottex ## @noindent -## for @var{x} >= 0. +## for @var{x} @geq{} 0. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/strings/strjust.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/strings/strjust.m Tue Jan 18 20:55:01 2011 -0800 @@ -23,10 +23,11 @@ ## be @samp{"left"}, @samp{"center"}, or @samp{"right"}. If @var{pos} ## is omitted, @samp{"right"} is assumed. ## -## Null characters are replaced by spaces. All other character +## Null characters are replaced by spaces. All other character ## data are treated as non-white space. ## ## Example: +## ## @example ## @group ## strjust (["a"; "ab"; "abc"; "abcd"])
--- a/scripts/strings/untabify.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/strings/untabify.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,12 +17,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function file} {} untabify (@var{t}) -## @deftypefnx {Function file} {} untabify (@var{t}, @var{tw}) -## @deftypefnx {Function file} {} untabify (@var{t}, @var{tw}, @var{deblank}) +## @deftypefn {Function File} {} untabify (@var{t}) +## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw}) +## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw}, @var{deblank}) ## Replace TAB characters in @var{t}, with spaces. ## The tab width is specified by @var{tw}, or defaults to eight. -## The input, @var{t}, may be either a 2D character array, or a cell +## The input, @var{t}, may be either a 2-D character array, or a cell ## array of character strings. The output is the same class ## as the input. ##
--- a/scripts/testfun/assert.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/testfun/assert.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {} assert (@var{cond}) ## @deftypefnx {Function File} {} assert (@var{cond}, @var{errmsg}, @dots{}) ## @deftypefnx {Function File} {} assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{}) -## @deftypefnx {Function File} {} assert (@var{observed},@var{expected}) -## @deftypefnx {Function File} {} assert (@var{observed},@var{expected},@var{tol}) +## @deftypefnx {Function File} {} assert (@var{observed}, @var{expected}) +## @deftypefnx {Function File} {} assert (@var{observed}, @var{expected}, @var{tol}) ## ## Produces an error if the condition is not met. @code{assert} can be ## called in three different ways.
--- a/scripts/testfun/demo.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/testfun/demo.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,7 +17,7 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} demo ('@var{name}',@var{n}) +## @deftypefn {Function File} {} demo ('@var{name}', @var{n}) ## ## Runs any examples associated with the function '@var{name}'. ## Examples are stored in the script file, or in a file with the same
--- a/scripts/testfun/example.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/testfun/example.m Tue Jan 18 20:55:01 2011 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} example ('@var{name}',@var{n}) -## @deftypefnx {Function File} {[@var{x}, @var{idx}] =} example ('@var{name}',@var{n}) +## @deftypefn {Function File} {} example ('@var{name}', @var{n}) +## @deftypefnx {Function File} {[@var{x}, @var{idx}] =} example ('@var{name}', @var{n}) ## ## Display the code for example @var{n} associated with the function ## '@var{name}', but do not run it. If @var{n} is not given, all examples
--- a/scripts/testfun/fail.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/testfun/fail.m Tue Jan 18 20:55:01 2011 -0800 @@ -20,8 +20,8 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} fail (@var{code},@var{pattern}) -## @deftypefnx {Function File} {} fail (@var{code},'warning',@var{pattern}) +## @deftypefn {Function File} {} fail (@var{code}, @var{pattern}) +## @deftypefnx {Function File} {} fail (@var{code}, 'warning', @var{pattern}) ## ## Return true if @var{code} fails with an error message matching ## @var{pattern}, otherwise produce an error. Note that @var{code}
--- a/scripts/testfun/test.m Mon Jan 17 20:18:07 2011 -0800 +++ b/scripts/testfun/test.m Tue Jan 18 20:55:01 2011 -0800 @@ -23,7 +23,7 @@ ## @deftypefnx {Function File} {} test ([], 'explain', @var{fid}) ## @deftypefnx {Function File} {@var{success} =} test (@dots{}) ## @deftypefnx {Function File} {[@var{n}, @var{max}] =} test (@dots{}) -## @deftypefnx {Function File} {[@var{code}, @var{idx}] =} test ('@var{name}','grabdemo') +## @deftypefnx {Function File} {[@var{code}, @var{idx}] =} test ('@var{name}', 'grabdemo') ## ## Perform tests from the first file in the loadpath matching @var{name}. ## @code{test} can be called as a command or as a function. Called with