Mercurial > octave-nkf
changeset 14359:7277fe922e99
doc: Use Octave preference for double quote in docstrings in scripts/
* interp1.m, interp2.m, interp3.m, interpn.m, profexplore.m, profile.m,
profshow.m, quadgk.m, lookfor.m, imagesc.m, bzip2.m, gzip.m, parseparams.m,
pkg.m, ancestor.m, caxis.m, ezmesh.m, ezmeshc.m, ezsurf.m, ezsurfc.m, hidden.m,
hold.m, patch.m, pie.m, pie3.m, quiver.m, quiver3.m, scatter3.m,
uicontextmenu.m, uicontrol.m, uipanel.m, uipushtool.m, uitoggletool.m,
uitoolbar.m, xlim.m, ylim.m, zlim.m, ismember.m, setxor.m, filter2.m, bicg.m,
demo.m, example.m, fail.m, test.m: Use Octave preference for double quote in
docstrings in scripts/ directory.
line wrap: on
line diff
--- a/scripts/general/interp1.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/interp1.m Mon Feb 13 07:38:23 2012 -0800 @@ -22,7 +22,7 @@ ## @deftypefnx {Function File} {@var{yi} =} interp1 (@var{y}, @var{xi}) ## @deftypefnx {Function File} {@var{yi} =} interp1 (@dots{}, @var{method}) ## @deftypefnx {Function File} {@var{yi} =} interp1 (@dots{}, @var{extrap}) -## @deftypefnx {Function File} {@var{pp} =} interp1 (@dots{}, 'pp') +## @deftypefnx {Function File} {@var{pp} =} interp1 (@dots{}, "pp") ## ## One-dimensional interpolation. Interpolate @var{y}, defined at the ## points @var{x}, at the points @var{xi}. The sample points @var{x} @@ -33,19 +33,19 @@ ## Method is one of: ## ## @table @asis -## @item 'nearest' +## @item "nearest" ## Return the nearest neighbor. ## -## @item 'linear' +## @item "linear" ## Linear interpolation from nearest neighbors ## -## @item 'pchip' +## @item "pchip" ## Piecewise cubic Hermite interpolating polynomial ## -## @item 'cubic' +## @item "cubic" ## Cubic interpolation (same as @code{pchip}) ## -## @item 'spline' +## @item "spline" ## Cubic spline interpolation---smooth first and second derivatives ## throughout the curve ## @end table @@ -53,18 +53,18 @@ ## Appending '*' to the start of the above method forces @code{interp1} ## to assume that @var{x} is uniformly spaced, and only @code{@var{x} ## (1)} and @code{@var{x} (2)} are referenced. This is usually faster, -## and is never slower. The default method is 'linear'. +## and is never slower. The default method is "linear". ## -## If @var{extrap} is the string 'extrap', then extrapolate values beyond +## If @var{extrap} is the string "extrap", then extrapolate values beyond ## the endpoints. If @var{extrap} is a number, replace values beyond the ## endpoints with that number. If @var{extrap} is missing, assume NA. ## -## If the string argument 'pp' is specified, then @var{xi} should not be +## If the string argument "pp" is specified, then @var{xi} should not be ## supplied and @code{interp1} returns the piecewise polynomial that ## can later be used with @code{ppval} to evaluate the interpolation. ## There is an equivalence, such that @code{ppval (interp1 (@var{x}, -## @var{y}, @var{method}, 'pp'), @var{xi}) == interp1 (@var{x}, @var{y}, -## @var{xi}, @var{method}, 'extrap')}. +## @var{y}, @var{method}, "pp"), @var{xi}) == interp1 (@var{x}, @var{y}, +## @var{xi}, @var{method}, "extrap")}. ## ## Duplicate points in @var{x} specify a discontinuous interpolant. There ## should be at most 2 consecutive points with the same value. @@ -353,7 +353,7 @@ ## For each type of interpolated test, confirm that the interpolated ## value at the knots match the values at the knots. Points away -## from the knots are requested, but only 'nearest' and 'linear' +## from the knots are requested, but only "nearest" and "linear" ## confirm they are the correct values. %!shared xp, yp, xi, style
--- a/scripts/general/interp2.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/interp2.m Mon Feb 13 07:38:23 2012 -0800 @@ -36,8 +36,8 @@ ## matrices @var{xi}, @var{yi}. ## ## If the last argument is a string, the interpolation method can -## be specified. The method can be 'linear', 'nearest' or 'cubic'. -## If it is omitted 'linear' interpolation is assumed. +## be specified. The method can be "linear", "nearest" or "cubic". +## If it is omitted "linear" interpolation is assumed. ## ## @item interp2 (@var{z}, @var{xi}, @var{yi}) ## Assumes @code{@var{x} = 1:rows (@var{z})} and @code{@var{y} = @@ -52,19 +52,19 @@ ## interpolation. It can take one of the following values ## ## @table @asis -## @item 'nearest' +## @item "nearest" ## Return the nearest neighbor. ## -## @item 'linear' +## @item "linear" ## Linear interpolation from nearest neighbors. ## -## @item 'pchip' +## @item "pchip" ## Piecewise cubic Hermite interpolating polynomial. ## -## @item 'cubic' +## @item "cubic" ## Cubic interpolation from four nearest neighbors. ## -## @item 'spline' +## @item "spline" ## Cubic spline interpolation---smooth first and second derivatives ## throughout the curve. ## @end table
--- a/scripts/general/interp3.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/interp3.m Mon Feb 13 07:38:23 2012 -0800 @@ -28,7 +28,7 @@ ## array @var{v} represents a 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 as the array -## @var{v} in the 'meshgrid' format or vectors. The parameters @var{xi}, etc. +## @var{v} in the "meshgrid" format or vectors. The parameters @var{xi}, etc. ## respect a similar format to @var{x}, etc., and they represent the points ## at which the array @var{vi} is interpolated. ## @@ -42,23 +42,23 @@ ## Method is one of: ## ## @table @asis -## @item 'nearest' +## @item "nearest" ## Return the nearest neighbor. ## -## @item 'linear' +## @item "linear" ## Linear interpolation from nearest neighbors. ## -## @item 'cubic' +## @item "cubic" ## Cubic interpolation from four nearest neighbors (not implemented yet). ## -## @item 'spline' +## @item "spline" ## Cubic spline interpolation---smooth first and second derivatives ## throughout the curve. ## @end table ## -## The default method is 'linear'. +## The default method is "linear". ## -## If @var{extrap} is the string 'extrap', then extrapolate values beyond +## If @var{extrap} is the string "extrap", then extrapolate values beyond ## the endpoints. If @var{extrap} is a number, replace values beyond the ## endpoints with that number. If @var{extrap} is missing, assume NA. ## @seealso{interp1, interp2, spline, meshgrid}
--- a/scripts/general/interpn.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/interpn.m Mon Feb 13 07:38:23 2012 -0800 @@ -29,7 +29,7 @@ ## at a location given by the parameters @var{x1}, @var{x2}, @dots{}, @var{xn}. ## The parameters @var{x1}, @var{x2}, @dots{}, @var{xn} are either ## @var{n}-dimensional arrays of the same size as the array @var{v} in -## the 'ndgrid' format or vectors. The parameters @var{y1}, etc. respect a +## the "ndgrid" format or vectors. The parameters @var{y1}, etc. respect a ## similar format to @var{x1}, etc., and they represent the points at which ## the array @var{vi} is interpolated. ## @@ -42,21 +42,21 @@ ## Method is one of: ## ## @table @asis -## @item 'nearest' +## @item "nearest" ## Return the nearest neighbor. ## -## @item 'linear' +## @item "linear" ## Linear interpolation from nearest neighbors. ## -## @item 'cubic' +## @item "cubic" ## Cubic interpolation from four nearest neighbors (not implemented yet). ## -## @item 'spline' +## @item "spline" ## Cubic spline interpolation---smooth first and second derivatives ## throughout the curve. ## @end table ## -## The default method is 'linear'. +## The default method is "linear". ## ## If @var{extrapval} is the scalar value, use it to replace the values ## beyond the endpoints with that number. If @var{extrapval} is missing,
--- a/scripts/general/profexplore.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/profexplore.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## Interactively explore hierarchical profiler output. ## ## Assuming @var{data} is the structure with profile data returned by -## @code{profile ('info')}, this command opens an interactive prompt +## @code{profile ("info")}, this command opens an interactive prompt ## that can be used to explore the call-tree. Type @kbd{help} to get a list ## of possible commands. ## @seealso{profile, profshow} @@ -45,7 +45,7 @@ endfunction ## This is the worker function. tree is the current subtree we want to -## display / explore. parents is a string containing the already 'rendered' +## display / explore. parents is a string containing the already "rendered" ## data for the parents which is displayed on top of the list of current ## children. prefix is the prefix to add to each line rendered; this ## is just a string of spaces to get indentation right.
--- a/scripts/general/profile.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/profile.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,8 +21,8 @@ ## @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') +## @deftypefnx {Function File} {@var{S} =} profile ("status") +## @deftypefnx {Function File} {@var{T} =} profile ("info") ## Control the built-in profiler. ## ## @table @code @@ -32,7 +32,7 @@ ## ## @item profile off ## Stop profiling. The collected data can later be retrieved and examined -## with calls like @code{S = profile ('info')}. +## with calls like @code{S = profile ("info")}. ## ## @item profile clear ## Clear all collected profiler data. @@ -41,12 +41,12 @@ ## Restart profiling without cleaning up the old data and instead ## all newly collected statistics are added to the already existing ones. ## -## @item @var{S} = profile ('status') +## @item @var{S} = profile ("status") ## Return a structure filled with certain information about the current status ## of the profiler. At the moment, the only field is @code{ProfilerStatus} -## which is either 'on' or 'off'. +## which is either "on" or "off". ## -## @item @var{T} = profile ('info') +## @item @var{T} = profile ("info") ## Return the collected profiling statistics in the structure @var{T}. ## The flat profile is returned in the field @code{FunctionTable} which is an ## array of structures, each entry corresponding to a function which was called
--- a/scripts/general/profshow.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/profshow.m Mon Feb 13 07:38:23 2012 -0800 @@ -22,7 +22,7 @@ ## Show flat profiler results. ## ## This command prints out profiler data as a flat profile. @var{data} is the -## structure returned by @code{profile ('info')}. If @var{n} is given, it +## structure returned by @code{profile ("info")}. If @var{n} is given, it ## specifies the number of functions to show in the profile; functions are ## sorted in descending order by total time spent in them. If there are more ## than @var{n} included in the profile, those will not be shown. @var{n}
--- a/scripts/general/quadgk.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/general/quadgk.m Mon Feb 13 07:38:23 2012 -0800 @@ -78,7 +78,7 @@ ## unacceptable error are subdivided and re-evaluated. If the number of ## subintervals exceeds 650 subintervals at any point then a poor ## convergence is signaled and the current estimate of the integral is -## returned. The property 'MaxIntervalCount' can be used to alter the +## returned. The property "MaxIntervalCount" can be used to alter the ## number of subintervals that can exist before exiting. ## ## @item WayPoints
--- a/scripts/help/lookfor.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/help/lookfor.m Mon Feb 13 07:38:23 2012 -0800 @@ -20,11 +20,11 @@ ## @deftypefn {Command} {} lookfor @var{str} ## @deftypefnx {Command} {} lookfor -all @var{str} ## @deftypefnx {Function File} {[@var{func}, @var{helpstring}] =} lookfor (@var{str}) -## @deftypefnx {Function File} {[@var{func}, @var{helpstring}] =} lookfor ('-all', @var{str}) +## @deftypefnx {Function File} {[@var{func}, @var{helpstring}] =} lookfor ("-all", @var{str}) ## Search for the string @var{str} in all functions found in the current ## function search path. By default, @code{lookfor} searches for @var{str} ## in the first sentence of the help string of each function found. The entire -## help text of each function can be searched if the '-all' argument is +## help text of each function can be searched if the "-all" argument is ## supplied. All searches are case insensitive. ## ## Called with no output arguments, @code{lookfor} prints the list of @@ -36,7 +36,7 @@ ## sentence of the help text is dependent on the format of the ## function's help. All Octave core functions are correctly ## formatted, but the same can not be guaranteed for external packages and -## user-supplied functions. Therefore, the use of the '-all' argument may +## user-supplied functions. Therefore, the use of the "-all" argument may ## be necessary to find related functions that are not a part of Octave. ## @seealso{help, doc, which} ## @end deftypefn
--- a/scripts/image/imagesc.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/image/imagesc.m Mon Feb 13 07:38:23 2012 -0800 @@ -25,7 +25,7 @@ ## Display a scaled version of the matrix @var{A} as a color image. The ## colormap is scaled so that the entries of the matrix occupy the entire ## colormap. If @var{limits} = [@var{lo}, @var{hi}] are given, then that -## range is set to the 'clim' of the current axes. +## range is set to the "clim" of the current axes. ## ## The axis values corresponding to the matrix elements are specified in ## @var{x} and @var{y}, either as pairs giving the minimum and maximum
--- a/scripts/miscellaneous/bzip2.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/miscellaneous/bzip2.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {@var{entries} =} bzip2 (@var{files}) ## @deftypefnx {Function File} {@var{entries} =} bzip2 (@var{files}, @var{outdir}) ## Compress the list of files specified in @var{files}. -## Each file is compressed separately and a new file with a '.bz2' extension +## Each file is compressed separately and a new file with a ".bz2" extension ## is created. The original files are not modified. Existing compressed files ## are silently overwritten. If @var{outdir} is defined the compressed ## files are placed in this directory.
--- a/scripts/miscellaneous/gzip.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/miscellaneous/gzip.m Mon Feb 13 07:38:23 2012 -0800 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {@var{entries} =} gzip (@var{files}) ## @deftypefnx {Function File} {@var{entries} =} gzip (@var{files}, @var{outdir}) ## Compress the list of files and/or directories specified in @var{files}. -## Each file is compressed separately and a new file with a '.gz' extension +## Each file is compressed separately and a new file with a ".gz" extension ## is created. The original files are not modified. Existing compressed ## files are silently overwritten. If @var{outdir} is defined the compressed ## files are placed in this directory.
--- a/scripts/miscellaneous/parseparams.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/miscellaneous/parseparams.m Mon Feb 13 07:38:23 2012 -0800 @@ -40,7 +40,7 @@ ## @end group ## @end example ## -## The parseparams function may be used to separate 'regular' +## The parseparams function may be used to separate "regular" ## arguments and additional arguments given as property/value pairs of ## the @var{varargin} cell array. ##
--- a/scripts/pkg/pkg.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/pkg/pkg.m Mon Feb 13 07:38:23 2012 -0800 @@ -136,7 +136,7 @@ ## [user_packages, system_packages] = pkg ("list") ## @end example ## -## The option '-forge' lists packages available at the Octave-Forge repository. +## The option "-forge" lists packages available at the Octave-Forge repository. ## This requires an internet connection and the cURL library. For example: ## ## @example @@ -145,7 +145,7 @@ ## ## @item describe ## Show a short description of the named installed packages, with the option -## '-verbose' also list functions provided by the package. For example, +## "-verbose" also list functions provided by the package. For example, ## ## @example ## pkg describe -verbose all
--- a/scripts/plot/ancestor.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ancestor.m Mon Feb 13 07:38:23 2012 -0800 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) -## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, 'toplevel') +## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, "toplevel") ## Return the first ancestor of handle object @var{h} whose type matches ## @var{type}, where @var{type} is a character string. If @var{type} is a ## cell array of strings, return the first parent whose type matches
--- a/scripts/plot/caxis.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/caxis.m Mon Feb 13 07:38:23 2012 -0800 @@ -26,8 +26,8 @@ ## colormap. Values outside this range are clamped to the first and last ## colormap entries. ## -## If @var{limits} is 'auto', then automatic colormap scaling is applied, -## whereas if @var{limits} is 'manual' the colormap scaling is set to manual. +## If @var{limits} is "auto", then automatic colormap scaling is applied, +## whereas if @var{limits} is "manual" the colormap scaling is set to manual. ## ## Called without any arguments to current color axis limits are returned. ##
--- a/scripts/plot/ezmesh.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ezmesh.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} ezmesh (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezmesh (@dots{}, @var{n}) -## @deftypefnx {Function File} {} ezmesh (@dots{}, 'circ') +## @deftypefnx {Function File} {} ezmesh (@dots{}, "circ") ## @deftypefnx {Function File} {} ezmesh (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ezmesh (@dots{}) ## @@ -41,7 +41,7 @@ ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}), ## @var{fz} (@var{s}, @var{t})]}. ## -## If the argument 'circ' is given, then the function is plotted over a disk +## If the argument "circ" is given, then the function is plotted over a disk ## centered on the middle of the domain @var{dom}. ## ## The optional return value @var{h} is a graphics handle to the created
--- a/scripts/plot/ezmeshc.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ezmeshc.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} ezmeshc (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezmeshc (@dots{}, @var{n}) -## @deftypefnx {Function File} {} ezmeshc (@dots{}, 'circ') +## @deftypefnx {Function File} {} ezmeshc (@dots{}, "circ") ## @deftypefnx {Function File} {} ezmeshc (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ezmeshc (@dots{}) ## @@ -41,7 +41,7 @@ ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}), ## @var{fz} (@var{s}, @var{t})]}. ## -## If the argument 'circ' is given, then the function is plotted over a disk +## If the argument "circ" is given, then the function is plotted over a disk ## centered on the middle of the domain @var{dom}. ## ## The optional return value @var{h} is a 2-element vector with a graphics
--- a/scripts/plot/ezsurf.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ezsurf.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} ezsurf (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezsurf (@dots{}, @var{n}) -## @deftypefnx {Function File} {} ezsurf (@dots{}, 'circ') +## @deftypefnx {Function File} {} ezsurf (@dots{}, "circ") ## @deftypefnx {Function File} {} ezsurf (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ezsurf (@dots{}) ## @@ -41,7 +41,7 @@ ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}), ## @var{fz} (@var{s}, @var{t})]}. ## -## If the argument 'circ' is given, then the function is plotted over a disk +## If the argument "circ" is given, then the function is plotted over a disk ## centered on the middle of the domain @var{dom}. ## ## The optional return value @var{h} is a graphics handle to the created
--- a/scripts/plot/ezsurfc.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ezsurfc.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} ezsurfc (@var{fx}, @var{fy}, @var{fz}) ## @deftypefnx {Function File} {} ezsurfc (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezsurfc (@dots{}, @var{n}) -## @deftypefnx {Function File} {} ezsurfc (@dots{}, 'circ') +## @deftypefnx {Function File} {} ezsurfc (@dots{}, "circ") ## @deftypefnx {Function File} {} ezsurfc (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ezsurfc (@dots{}) ## @@ -41,7 +41,7 @@ ## function @code{[@var{fx} (@var{s}, @var{t}), @var{fy} (@var{s}, @var{t}), ## @var{fz} (@var{s}, @var{t})]}. ## -## If the argument 'circ' is given, then the function is plotted over a disk +## If the argument "circ" is given, then the function is plotted over a disk ## centered on the middle of the domain @var{dom}. ## ## The optional return value @var{h} is a 2-element vector with a graphics
--- a/scripts/plot/hidden.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/hidden.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} hidden () ## Manipulation the mesh hidden line removal. Called with no argument ## the hidden line removal is toggled. The argument @var{mode} can be either -## 'on' or 'off' and the set of the hidden line removal is set accordingly. +## "on" or "off" and the set of the hidden line removal is set accordingly. ## @seealso{mesh, meshc, surf} ## @end deftypefn
--- a/scripts/plot/hold.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/hold.m Mon Feb 13 07:38:23 2012 -0800 @@ -20,7 +20,7 @@ ## @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 +## 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 ## objects. ## @@ -39,13 +39,13 @@ ## command. (default). ## ## @item hold -## Toggle the current 'hold' state. +## Toggle the current hold state. ## @end table ## ## When given the additional argument @var{hax}, the hold state is modified ## only for the given axis handle. ## -## To query the current 'hold' state use the @code{ishold} function. +## To query the current hold state use the @code{ishold} function. ## @seealso{ishold, cla, newplot, clf} ## @end deftypefn
--- a/scripts/plot/patch.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/patch.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c}) ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{z}, @var{c}) ## @deftypefnx {Function File} {} patch (@var{fv}) -## @deftypefnx {Function File} {} patch ('Faces', @var{f}, 'Vertices', @var{v}, @dots{}) +## @deftypefnx {Function File} {} patch ("Faces", @var{f}, "Vertices", @var{v}, @dots{}) ## @deftypefnx {Function File} {} patch (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} patch (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} patch (@dots{})
--- a/scripts/plot/pie.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/pie.m Mon Feb 13 07:38:23 2012 -0800 @@ -29,7 +29,7 @@ ## size of the values of @var{x}. ## ## The variable @var{explode} is a vector of the same length as @var{x} that -## if non zero 'explodes' the slice from the pie chart. +## if non zero "explodes" the slice from the pie chart. ## ## If given @var{labels} is a cell array of strings of the same length as ## @var{x}, giving the labels of each of the slices of the pie chart.
--- a/scripts/plot/pie3.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/pie3.m Mon Feb 13 07:38:23 2012 -0800 @@ -30,7 +30,7 @@ ## size of the values of @var{x}. ## ## The variable @var{explode} is a vector of the same length as @var{x} that -## if non zero 'explodes' the slice from the pie chart. +## if non zero "explodes" the slice from the pie chart. ## ## If given @var{labels} is a cell array of strings of the same length as ## @var{x}, giving the labels of each of the slices of the pie chart.
--- a/scripts/plot/quiver.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/quiver.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} quiver (@var{x}, @var{y}, @var{u}, @var{v}) ## @deftypefnx {Function File} {} quiver (@dots{}, @var{s}) ## @deftypefnx {Function File} {} quiver (@dots{}, @var{style}) -## @deftypefnx {Function File} {} quiver (@dots{}, 'filled') +## @deftypefnx {Function File} {} quiver (@dots{}, "filled") ## @deftypefnx {Function File} {} quiver (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{}) ## @@ -40,7 +40,7 @@ ## The style to use for the plot can be defined with a line style @var{style} ## in a similar manner to the line styles used with the @code{plot} command. ## If a marker is specified then markers at the grid points of the vectors are -## printed rather than arrows. If the argument 'filled' is given then the +## printed rather than arrows. If the argument "filled" is given then the ## markers as filled. ## ## The optional return value @var{h} is a graphics handle to a quiver object.
--- a/scripts/plot/quiver3.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/quiver3.m Mon Feb 13 07:38:23 2012 -0800 @@ -21,7 +21,7 @@ ## @deftypefnx {Function File} {} quiver3 (@var{x}, @var{y}, @var{z}, @var{u}, @var{v}, @var{w}) ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{s}) ## @deftypefnx {Function File} {} quiver3 (@dots{}, @var{style}) -## @deftypefnx {Function File} {} quiver3 (@dots{}, 'filled') +## @deftypefnx {Function File} {} quiver3 (@dots{}, "filled") ## @deftypefnx {Function File} {} quiver3 (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} quiver3 (@dots{}) ## @@ -40,7 +40,7 @@ ## The style to use for the plot can be defined with a line style @var{style} ## in a similar manner to the line styles used with the @code{plot} command. ## If a marker is specified then markers at the grid points of the vectors are -## printed rather than arrows. If the argument 'filled' is given then the +## printed rather than arrows. If the argument "filled" is given then the ## markers as filled. ## ## The optional return value @var{h} is a graphics handle to a quiver object.
--- a/scripts/plot/scatter3.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/scatter3.m Mon Feb 13 07:38:23 2012 -0800 @@ -18,7 +18,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s}, @var{c}) -## @deftypefnx {Function File} {} scatter3 (@dots{}, 'filled') +## @deftypefnx {Function File} {} scatter3 (@dots{}, "filled") ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{style}) ## @deftypefnx {Function File} {} scatter3 (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} scatter3 (@var{h}, @dots{}) @@ -38,7 +38,7 @@ ## ## The marker to use can be changed with the @var{style} argument, that is a ## string defining a marker in the same manner as the @code{plot} command. -## If the argument 'filled' is given then the markers as filled. All +## If the argument "filled" is given then the markers as filled. All ## additional arguments are passed to the underlying patch command. ## ## The optional return value @var{h} is a graphics handle to the hggroup
--- a/scripts/plot/uicontextmenu.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uicontextmenu.m Mon Feb 13 07:38:23 2012 -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/uicontrol.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uicontrol.m Mon Feb 13 07:38:23 2012 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uicontrol ('Name', value, @dots{}) -## @deftypefnx {Function File} {@var{handle} =} uicontrol (@var{parent}, 'Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uicontrol ("Name", value, @dots{}) +## @deftypefnx {Function File} {@var{handle} =} uicontrol (@var{parent}, "Name", value, @dots{}) ## @deftypefnx {Function File} {} uicontrol (@var{handle}) ## @end deftypefn
--- a/scripts/plot/uipanel.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uipanel.m Mon Feb 13 07:38:23 2012 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uipanel ('Name', value, @dots{}) -## @deftypefnx {Function File} {@var{handle} =} uipanel (@var{parent}, 'Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uipanel ("Name", value, @dots{}) +## @deftypefnx {Function File} {@var{handle} =} uipanel (@var{parent}, "Name", value, @dots{}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/uipushtool.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uipushtool.m Mon Feb 13 07:38:23 2012 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uipushtool ('Name', value, @dots{}) -## @deftypefnx {Function File} {@var{handle} =} uipushtool (@var{parent}, 'Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uipushtool ("Name", value, @dots{}) +## @deftypefnx {Function File} {@var{handle} =} uipushtool (@var{parent}, "Name", value, @dots{}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/uitoggletool.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uitoggletool.m Mon Feb 13 07:38:23 2012 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uitoggletool ('Name', value, @dots{}) -## @deftypefnx {Function File} {@var{handle} =} uitoggletool (@var{parent}, 'Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uitoggletool ("Name", value, @dots{}) +## @deftypefnx {Function File} {@var{handle} =} uitoggletool (@var{parent}, "Name", value, @dots{}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/uitoolbar.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/uitoolbar.m Mon Feb 13 07:38:23 2012 -0800 @@ -17,8 +17,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{handle} =} uitoolbar ('Name', value, @dots{}) -## @deftypefnx {Function File} {@var{handle} =} uitoolbar (@var{parent}, 'Name', value, @dots{}) +## @deftypefn {Function File} {@var{handle} =} uitoolbar ("Name", value, @dots{}) +## @deftypefnx {Function File} {@var{handle} =} uitoolbar (@var{parent}, "Name", value, @dots{}) ## @end deftypefn ## Author: goffioul
--- a/scripts/plot/xlim.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/xlim.m Mon Feb 13 07:38:23 2012 -0800 @@ -23,7 +23,7 @@ ## ## @deftypefn {Function File} {@var{xl} =} xlim () ## @deftypefnx {Function File} {} xlim (@var{xl}) -## @deftypefnx {Function File} {@var{m} =} xlim ('mode') +## @deftypefnx {Function File} {@var{m} =} xlim ("mode") ## @deftypefnx {Function File} {} xlim (@var{m}) ## @deftypefnx {Function File} {} xlim (@var{h}, @dots{}) ## Get or set the limits of the x-axis of the current plot. Called without @@ -32,8 +32,8 @@ ## to this value. ## ## The current mode for calculation of the x-axis can be returned with a -## call @code{xlim ('mode')}, and can be either 'auto' or 'manual'. The -## current plotting mode can be set by passing either 'auto' or 'manual' +## call @code{xlim ("mode")}, and can be either "auto" or "manual". The +## current plotting mode can be set by passing either "auto" or "manual" ## as the argument. ## ## If passed a handle as the first argument, then operate on this handle
--- a/scripts/plot/ylim.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/ylim.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{yl} =} ylim () ## @deftypefnx {Function File} {} ylim (@var{yl}) -## @deftypefnx {Function File} {@var{m} =} ylim ('mode') +## @deftypefnx {Function File} {@var{m} =} ylim ("mode") ## @deftypefnx {Function File} {} ylim (@var{m}) ## @deftypefnx {Function File} {} ylim (@var{h}, @dots{}) ## Get or set the limits of the y-axis of the current plot. Called without @@ -28,8 +28,8 @@ ## to this value. ## ## The current mode for calculation of the y-axis can be returned with a -## call @code{ylim ('mode')}, and can be either 'auto' or 'manual'. The -## current plotting mode can be set by passing either 'auto' or 'manual' +## call @code{ylim ("mode")}, and can be either "auto" or "manual". The +## current plotting mode can be set by passing either "auto" or "manual" ## as the argument. ## ## If passed a handle as the first argument, then operate on this handle
--- a/scripts/plot/zlim.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/plot/zlim.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{zl} =} zlim () ## @deftypefnx {Function File} {} zlim (@var{zl}) -## @deftypefnx {Function File} {@var{m} =} zlim ('mode') +## @deftypefnx {Function File} {@var{m} =} zlim ("mode") ## @deftypefnx {Function File} {} zlim (@var{m}) ## @deftypefnx {Function File} {} zlim (@var{h}, @dots{}) ## Get or set the limits of the z-axis of the current plot. Called without @@ -28,8 +28,8 @@ ## to this value. ## ## The current mode for calculation of the z-axis can be returned with a -## call @code{zlim ('mode')}, and can be either 'auto' or 'manual'. The -## current plotting mode can be set by passing either 'auto' or 'manual' +## call @code{zlim ("mode")}, and can be either "auto" or "manual". The +## current plotting mode can be set by passing either "auto" or "manual" ## as the argument. ## ## If passed a handle as the first argument, then operate on this handle
--- a/scripts/set/ismember.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/set/ismember.m Mon Feb 13 07:38:23 2012 -0800 @@ -40,8 +40,8 @@ ## ## @example ## @group -## a = @{'abc'@}; -## s = @{'abc', 'def'@}; +## a = @{"abc"@}; +## s = @{"abc", "def"@}; ## [tf, s_idx] = ismember (a, s) ## @result{} tf = [1, 0] ## @result{} s_idx = [1, 0]
--- a/scripts/set/setxor.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/set/setxor.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} setxor (@var{a}, @var{b}) -## @deftypefnx {Function File} {} setxor (@var{a}, @var{b}, 'rows') +## @deftypefnx {Function File} {} setxor (@var{a}, @var{b}, "rows") ## @deftypefnx {Function File} {[@var{c}, @var{ia}, @var{ib}] =} setxor (@var{a}, @var{b}) ## ## Return the elements exclusive to @var{a} or @var{b}, sorted in ascending
--- a/scripts/signal/filter2.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/signal/filter2.m Mon Feb 13 07:38:23 2012 -0800 @@ -24,13 +24,13 @@ ## Possible values are: ## ## @table @asis -## @item 'full' +## @item "full" ## pad @var{x} with zeros on all sides before filtering. ## -## @item 'same' +## @item "same" ## unpadded @var{x} (default) ## -## @item 'valid' +## @item "valid" ## trim @var{x} after filtering so edge effects are no included. ## @end table ##
--- a/scripts/sparse/bicg.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/sparse/bicg.m Mon Feb 13 07:38:23 2012 -0800 @@ -40,8 +40,8 @@ ## 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, 'notransp') = M1 \ x} or @code{g(x, 'notransp') = M2 \ x} and -## @code{g(x, 'transp') = M1' \ x} or @code{g(x, 'transp') = M2' \ x}. +## @code{g(x, "notransp") = M1 \ x} or @code{g(x, "notransp") = M2 \ x} and +## @code{g(x, "transp") = M1' \ x} or @code{g(x, "transp") = M2' \ x}. ## ## If called with more than one output parameter ##
--- a/scripts/testfun/demo.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/testfun/demo.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,8 +19,8 @@ ## -*- texinfo -*- ## @deftypefn {Command} {} demo @var{name} ## @deftypefnx {Command} {} demo @var{name} @var{n} -## @deftypefnx {Function File} {} demo ('@var{name}') -## @deftypefnx {Function File} {} demo ('@var{name}', @var{n}) +## @deftypefnx {Function File} {} demo ("@var{name}") +## @deftypefnx {Function File} {} demo ("@var{name}", @var{n}) ## ## Run example code block @var{n} associated with the function @var{name}. ## If @var{n} is not specified, all examples are run. @@ -65,7 +65,7 @@ ## Also, because demo evaluates within a function context, you cannot ## define new functions inside a demo. If you must have function blocks, ## rather than just anonymous functions or inline functions, you will have to -## use @code{eval(example('function',n))} to see them. Because eval only +## use @code{eval(example("function",n))} to see them. Because eval only ## evaluates one line, or one statement if the statement crosses ## multiple lines, you must wrap your demo in "if 1 <demo stuff> endif" ## with the 'if' on the same line as 'demo'. For example:
--- a/scripts/testfun/example.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/testfun/example.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,12 +19,12 @@ ## -*- texinfo -*- ## @deftypefn {Command} {} example @var{name} ## @deftypefnx {Command} {} example @var{name} @var{n} -## @deftypefnx {Function File} {} example ('@var{name}') -## @deftypefnx {Function File} {} example ('@var{name}', @var{n}) +## @deftypefnx {Function File} {} example ("@var{name}") +## @deftypefnx {Function File} {} example ("@var{name}", @var{n}) ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{}) ## ## Display the code for example @var{n} associated with the function -## '@var{name}', but do not run it. If @var{n} is not specified, all examples +## "@var{name}", but do not run it. If @var{n} is not specified, all examples ## are displayed. ## ## When called with output arguments, the examples are returned in the form of
--- a/scripts/testfun/fail.m Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/testfun/fail.m Mon Feb 13 07:38:23 2012 -0800 @@ -22,7 +22,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} fail (@var{code}) ## @deftypefnx {Function File} {} fail (@var{code}, @var{pattern}) -## @deftypefnx {Function File} {} fail (@var{code}, 'warning', @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 Sun Feb 12 16:02:26 2012 -0500 +++ b/scripts/testfun/test.m Mon Feb 13 07:38:23 2012 -0800 @@ -19,11 +19,11 @@ ## -*- texinfo -*- ## @deftypefn {Command} {} test @var{name} ## @deftypefnx {Command} {} test @var{name} quiet|normal|verbose -## @deftypefnx {Function File} {} test ('@var{name}', 'quiet|normal|verbose', @var{fid}) -## @deftypefnx {Function File} {} test ([], 'explain', @var{fid}) +## @deftypefnx {Function File} {} test ("@var{name}", "quiet|normal|verbose", @var{fid}) +## @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 @@ -34,14 +34,14 @@ ## output is selected. ## ## @table @asis -## @item 'quiet' +## @item "quiet" ## Don't report all the tests as they happen, just the errors. ## -## @item 'normal' +## @item "normal" ## Report all tests as they happen, but don't do tests which require ## user interaction. ## -## @item 'verbose' +## @item "verbose" ## Do tests which require user interaction. ## @end table ## @@ -58,12 +58,12 @@ ## @var{n} and @var{max}, the number of successful tests and the total number ## of tests in the file @var{name} are returned. ## -## If the second argument is the string 'grabdemo', the contents of the demo +## If the second argument is the string "grabdemo", the contents of the demo ## blocks are extracted but not executed. Code for all code blocks is ## concatenated and returned as @var{code} with @var{idx} being a vector of ## positions of the ends of the demo blocks. ## -## If the second argument is 'explain', then @var{name} is ignored and an +## If the second argument is "explain", then @var{name} is ignored and an ## explanation of the line markers used is written to the file @var{fid}. ## @seealso{assert, fail, error, demo, example} ## @end deftypefn