# HG changeset patch # User Rik # Date 1411444014 25200 # Node ID 0f9c5a15c8faa5f06ce482188e33134d01609b22 # Parent e09318118fd6190cd9e3f2be99dcf5d1462f8e4c doc: Periodic grammarcheck of documentation. * doc/interpreter/contrib.txi, doc/interpreter/expr.txi, doc/interpreter/func.txi, doc/interpreter/linalg.txi, doc/interpreter/plot.txi, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/profiler.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, scripts/general/deal.m, scripts/help/__gripe_missing_component__.m, scripts/miscellaneous/desktop.m, scripts/pkg/private/default_prefix.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/util/pan.m, scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m, scripts/plot/util/zoom.m, scripts/signal/periodogram.m, scripts/specfun/factor.m, scripts/specfun/primes.m, scripts/statistics/base/lscov.m, scripts/testfun/private/compare_plot_demos.m, scripts/testfun/private/dump_demos.m, scripts/testfun/private/html_compare_plot_demos.m, scripts/testfun/test.m: Periodic grammarcheck of documentation. diff -r e09318118fd6 -r 0f9c5a15c8fa doc/interpreter/contrib.txi --- a/doc/interpreter/contrib.txi Mon Sep 22 20:25:21 2014 -0700 +++ b/doc/interpreter/contrib.txi Mon Sep 22 20:46:54 2014 -0700 @@ -198,6 +198,7 @@ comment header (use appropriate year, name and comment marks): @example +@group ## Copyright (C) 1996-2013 John W. Eaton ## ## This file is part of Octave. @@ -215,6 +216,7 @@ ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, ## see . +@end group @end example Always include commit messages in changesets. After making your source diff -r e09318118fd6 -r 0f9c5a15c8fa doc/interpreter/expr.txi --- a/doc/interpreter/expr.txi Mon Sep 22 20:25:21 2014 -0700 +++ b/doc/interpreter/expr.txi Mon Sep 22 20:46:54 2014 -0700 @@ -1243,8 +1243,10 @@ is evaluated as @example +@group @var{temp} = @var{expr2} @var{expr1} = (@var{expr1}) @var{op} @var{temp} +@end group @end example @noindent diff -r e09318118fd6 -r 0f9c5a15c8fa doc/interpreter/func.txi --- a/doc/interpreter/func.txi Mon Sep 22 20:25:21 2014 -0700 +++ b/doc/interpreter/func.txi Mon Sep 22 20:46:54 2014 -0700 @@ -1406,7 +1406,8 @@ @strong{Caution}: @sc{matlab} has begun the process of deprecating inline functions. At some point in the future support will be dropped and eventually -Octave will follow @sc{matlab} and also remove inline functions. Use anonymous functions in all new code. +Octave will follow @sc{matlab} and also remove inline functions. Use anonymous +functions in all new code. @DOCSTRING(inline) diff -r e09318118fd6 -r 0f9c5a15c8fa doc/interpreter/linalg.txi --- a/doc/interpreter/linalg.txi Mon Sep 22 20:25:21 2014 -0700 +++ b/doc/interpreter/linalg.txi Mon Sep 22 20:46:54 2014 -0700 @@ -29,7 +29,7 @@ A common text for engineering courses is @nospell{G. Strang}, @cite{Linear Algebra and Its Applications, 4th Edition}. It has become a -widespread reference for linear algebra. An alternative is P. Lax +widespread reference for linear algebra. An alternative is P. Lax @cite{Linear Algebra and Its Applications}, and also is a good choice. It claims to be suitable for high school students with substantial mathematical interests as well as first-year undergraduates. diff -r e09318118fd6 -r 0f9c5a15c8fa doc/interpreter/plot.txi --- a/doc/interpreter/plot.txi Mon Sep 22 20:25:21 2014 -0700 +++ b/doc/interpreter/plot.txi Mon Sep 22 20:46:54 2014 -0700 @@ -1473,6 +1473,7 @@ and their origin is the lower left corner of the plotting area. Events which sets @qcode{"currentpoint"} are + @table @asis @item A mouse button was pressed always @@ -1588,6 +1589,7 @@ @item selectiontype Holds information about the last mouse button press within the figure. May be one of + @table @asis @item @qcode{"normal"} Left mouse button click. @@ -1718,7 +1720,7 @@ coordinates of the point over which the mouse pointer was when the mouse button was pressed in axes data units. If a mouse callback function is defined, @qcode{"currentpoint"} holds the pointer -coordinates at the time the mouse button was pressed. For 3D plots, +coordinates at the time the mouse button was pressed. For 3-D plots, the first row of the returned matrix specifies the point nearest to the current camera position and the second rows the furthest point. The two points forms a line which is perpendicular to the screen. diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/data.cc --- a/libinterp/corefcn/data.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/data.cc Mon Sep 22 20:46:54 2014 -0700 @@ -2601,7 +2601,7 @@ @code{1:ndims (A)} (in any order, but each element must appear only once).\n\ \n\ The @var{N}th dimension of @var{A} gets remapped to dimension \n\ -@code{@var{PERM}(@var{N})}. For example,\n\ +@code{@var{PERM}(@var{N})}. For example:\n\ \n\ @example\n\ @group\n\ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/debug.cc --- a/libinterp/corefcn/debug.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/debug.cc Mon Sep 22 20:46:54 2014 -0700 @@ -633,9 +633,9 @@ DEFUN (dbstop, args, , "-*- texinfo -*-\n\ -@deftypefn {Command} dbstop @var{func}\n\ -@deftypefnx {Command} dbstop @var{func} @var{line}\n\ -@deftypefnx {Command} dbstop @var{func} @var{line1} @var{line2} @dots{}\n\ +@deftypefn {Command} {} dbstop @var{func}\n\ +@deftypefnx {Command} {} dbstop @var{func} @var{line}\n\ +@deftypefnx {Command} {} dbstop @var{func} @var{line1} @var{line2} @dots{}\n\ @deftypefnx {Command} {} dbstop @var{line} @dots{}\n\ @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\")\n\ @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line})\n\ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/graphics.cc --- a/libinterp/corefcn/graphics.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/graphics.cc Mon Sep 22 20:46:54 2014 -0700 @@ -9443,7 +9443,7 @@ DEFUN (__is_handle_visible__, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} __is_handle_visible__ (@var{h})\n\ +@deftypefn {Built-in Function} {} __is_handle_visible__ (@var{h})\n\ Undocumented internal function.\n\ @end deftypefn") { diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/help.cc --- a/libinterp/corefcn/help.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/help.cc Mon Sep 22 20:46:54 2014 -0700 @@ -1173,7 +1173,7 @@ DEFUN (__operators__, , , "-*- texinfo -*-\n\ -@deftypefn {Function File} __operators__ ()\n\ +@deftypefn {Function File} {} __operators__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { @@ -1185,7 +1185,7 @@ DEFUN (__keywords__, , , "-*- texinfo -*-\n\ -@deftypefn {Function File} __keywords__ ()\n\ +@deftypefn {Function File} {} __keywords__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { @@ -1197,7 +1197,7 @@ DEFUN (__builtins__, , , "-*- texinfo -*-\n\ -@deftypefn {Function File} __builtins__ ()\n\ +@deftypefn {Function File} {} __builtins__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/load-save.cc --- a/libinterp/corefcn/load-save.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/load-save.cc Mon Sep 22 20:46:54 2014 -0700 @@ -1480,15 +1480,14 @@ @deftypefnx {Command} {} {@var{s} =} save @samp{-} @var{v1} @var{v2} @dots{}\n\ Save the named variables @var{v1}, @var{v2}, @dots{}, in the file\n\ @var{file}. The special filename @samp{-} may be used to return the\n\ -content of the variables as a string. If no variable names are listed, Octave saves\n\ -all the variables in the current scope. Otherwise, full variable names or\n\ -pattern syntax can be used to specify the variables to save.\n\ -If the @option{-struct} modifier is used, fields @var{f1} @var{f2} @dots{}\n\ -of the scalar structure @var{STRUCT} are saved as if they were variables\n\ -with corresponding names.\n\ -Valid options for the @code{save} command are listed in the following table.\n\ -Options that modify the output format override the format specified by\n\ -@code{save_default_options}.\n\ +content of the variables as a string. If no variable names are listed,\n\ +Octave saves all the variables in the current scope. Otherwise, full\n\ +variable names or pattern syntax can be used to specify the variables to\n\ +save. If the @option{-struct} modifier is used, fields @var{f1} @var{f2}\n\ +@dots{} of the scalar structure @var{STRUCT} are saved as if they were\n\ +variables with corresponding names. Valid options for the @code{save}\n\ +command are listed in the following table. Options that modify the output\n\ +format override the format specified by @code{save_default_options}.\n\ \n\ If save is invoked using the functional form\n\ \n\ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/profiler.cc --- a/libinterp/corefcn/profiler.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/profiler.cc Mon Sep 22 20:46:54 2014 -0700 @@ -419,7 +419,7 @@ // Enable or disable the profiler data collection. DEFUN (__profiler_enable__, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} __profiler_enable__ ()\n\ +@deftypefn {Function File} {} __profiler_enable__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { @@ -445,7 +445,7 @@ // Clear all collected profiling data. DEFUN (__profiler_reset__, args, , "-*- texinfo -*-\n\ -@deftypefn {Function File} __profiler_reset__ ()\n\ +@deftypefn {Function File} {} __profiler_reset__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { @@ -463,7 +463,7 @@ // Query the timings collected by the profiler. DEFUN (__profiler_data__, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Function File} __profiler_data__ ()\n\ +@deftypefn {Function File} {} __profiler_data__ ()\n\ Undocumented internal function.\n\ @end deftypefn") { diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/syscalls.cc --- a/libinterp/corefcn/syscalls.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/syscalls.cc Mon Sep 22 20:46:54 2014 -0700 @@ -1881,7 +1881,7 @@ DEFUNX ("O_TRUNC", FO_TRUNC, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} O_TRUNC ()\n\ +@deftypefn {Built-in Function} {} O_TRUNC ()\n\ Return the numerical value of the file status flag that may be\n\ returned by @code{fcntl} to indicate that if file exists, it should\n\ be truncated when writing.\n\ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/utils.cc --- a/libinterp/corefcn/utils.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/utils.cc Mon Sep 22 20:46:54 2014 -0700 @@ -1519,9 +1519,10 @@ DEFUN (isstudent, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} isstudent ()\n\ -Return true if running in the student edition of Matlab.\n\ -Always return false in Octave.\n\ +@deftypefn {Built-in Function} {} isstudent ()\n\ +Return true if running in the student edition of @sc{matlab}.\n\ +\n\ +@code{isstudent} always returns false in Octave.\n\ \n\ @seealso{false}\n\ @end deftypefn") @@ -1533,6 +1534,7 @@ } /* -%!assert (isstudent (), false); -%!error isstudent (1); +%!assert (isstudent (), false) + +%!error isstudent (1) */ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/corefcn/variables.cc --- a/libinterp/corefcn/variables.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/corefcn/variables.cc Mon Sep 22 20:46:54 2014 -0700 @@ -566,7 +566,8 @@ Check only for files and directories.\n\ \n\ @item @qcode{\"class\"}\n\ -Check only for classes. (Note: This option is accepted, but not currently implemented)\n\ +Check only for classes. (Note: This option is accepted, but not currently\n\ +implemented)\n\ @end table\n\ \n\ If no type is given, and there are multiple possible matches for name,\n\ diff -r e09318118fd6 -r 0f9c5a15c8fa libinterp/dldfcn/__init_fltk__.cc --- a/libinterp/dldfcn/__init_fltk__.cc Mon Sep 22 20:25:21 2014 -0700 +++ b/libinterp/dldfcn/__init_fltk__.cc Mon Sep 22 20:46:54 2014 -0700 @@ -2231,7 +2231,7 @@ DEFUN_DLD (__fltk_check__, , , "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} __fltk_check__ ()\n\ -Undocumented internal function. Calls Fl::check ()\n\ +Undocumented internal function. Calls Fl::check ()\n\ @end deftypefn") { #ifdef HAVE_FLTK diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/general/deal.m --- a/scripts/general/deal.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/general/deal.m Mon Sep 22 20:46:54 2014 -0700 @@ -58,7 +58,7 @@ ## Programming Note: @code{deal} is often used with comma separated lists ## derived from cell arrays or structures. This is unnecessary as the ## interpreter can perform the same action without the overhead of a function -## call. For example, +## call. For example: ## ## @example ## @group @@ -66,9 +66,9 @@ ## [x, y, z ] = c@{:@} ## @result{} ## x = -## +## ## 1 2 -## +## ## y = Three ## z = 4 ## @end group diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/help/__gripe_missing_component__.m --- a/scripts/help/__gripe_missing_component__.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/help/__gripe_missing_component__.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} __gripe_missing_component__ (@var{caller}, @var{component}) +## @deftypefn {Function File} {} __gripe_missing_component__ (@var{caller}, @var{component}) ## Undocumented internal function. ## @end deftypefn diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/miscellaneous/desktop.m --- a/scripts/miscellaneous/desktop.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/miscellaneous/desktop.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} @var{used} = desktop ("-inuse") +## @deftypefn {Function File} {@var{used} =} desktop ("-inuse") ## Return true if the desktop (GUI) is currently in use. ## @seealso{isguirunning} ## @end deftypefn diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/pkg/private/default_prefix.m --- a/scripts/pkg/private/default_prefix.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/pkg/private/default_prefix.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,8 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{prefix}, @var{archprefix} =} @ -## default_prefix (@var{global_install}) +## @deftypefn {Function File} {[@var{prefix}, @var{archprefix} =} default_prefix (@var{global_install}) ## Undocumented internal function. ## @end deftypefn diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/plot/appearance/__getlegenddata__.m --- a/scripts/plot/appearance/__getlegenddata__.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/plot/appearance/__getlegenddata__.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{hplots}, @var{strings}]} = __getlegenddata__ (@var{h}) +## @deftypefn {Function File} {[@var{hplots}, @var{strings}] =} __getlegenddata__ (@var{h}) ## Undocumented internal function. ## @end deftypefn diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/plot/util/pan.m --- a/scripts/plot/util/pan.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/plot/util/pan.m Mon Sep 22 20:46:54 2014 -0700 @@ -39,6 +39,7 @@ ## ## To query the current mode use the @code{get} ## function. For example: +## ## @example ## mode = get (gca, "pan"); ## @end example diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/plot/util/rotate.m --- a/scripts/plot/util/rotate.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/plot/util/rotate.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} rotate (@var{h}, @var{dir}, @var{alpha}) +## @deftypefn {Function File} {} rotate (@var{h}, @var{dir}, @var{alpha}) ## @deftypefnx {Function File} {} rotate (@dots{}, @var{origin}) ## Rotate the plot object @var{h} through @var{alpha} degrees around ## the line with direction @var{dir} and origin @var{origin}. diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/plot/util/rotate3d.m --- a/scripts/plot/util/rotate3d.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/plot/util/rotate3d.m Mon Sep 22 20:46:54 2014 -0700 @@ -21,15 +21,16 @@ ## @deftypefnx {Command} {} rotate3d on ## @deftypefnx {Command} {} rotate3d off ## @deftypefnx {Function File} {} rotate3d (@var{hax}, @dots{}) -## Control 3D rotation mode of interactive graph in GUI. +## Control 3-D rotation mode of interactive graph in GUI. ## ## The function state input may be either @qcode{"on"} or @qcode{"off"} -## and can only be set for 3D plots. +## and can only be set for 3-D plots. ## ## If the first argument @var{hax} is an axes handle, then operate on ## this axis rather than the current axes returned by @code{gca}. ## ## To query the current mode use the @code{get} function. For example: +## ## @example ## mode = get (gca, "rotate3d"); ## @end example diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/plot/util/zoom.m --- a/scripts/plot/util/zoom.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/plot/util/zoom.m Mon Sep 22 20:46:54 2014 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Command} {} zoom (@var{factor}) +## @deftypefn {Command} {} zoom (@var{factor}) ## @deftypefnx {Command} {} zoom out ## @deftypefnx {Command} {} zoom reset ## Zoom the current axes object. diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/signal/periodogram.m --- a/scripts/signal/periodogram.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/signal/periodogram.m Mon Sep 22 20:46:54 2014 -0700 @@ -55,7 +55,7 @@ ## ## @item range ## range of spectrum. @qcode{"@nospell{onesided}"} computes spectrum from -## [0..nfft/2+1]. @qcode{"@nospell{twosided}"} computes spectrum from +## [0..nfft/2+1]. @qcode{"@nospell{twosided}"} computes spectrum from ## [0..nfft-1]. ## @end table ## diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/specfun/factor.m --- a/scripts/specfun/factor.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/specfun/factor.m Mon Sep 22 20:46:54 2014 -0700 @@ -28,7 +28,7 @@ ## With two output arguments, return the unique prime factors @var{pf} and ## their multiplicities. That is, @code{prod (@var{pf} .^ @var{n}) == @var{q}}. ## -## Implementation Note: The input @var{q} must be less than than +## Implementation Note: The input @var{q} must be less than ## @code{bitmax} (9.0072e+15) in order to factor correctly. ## @seealso{gcd, lcm, isprime, primes} ## @end deftypefn diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/specfun/primes.m --- a/scripts/specfun/primes.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/specfun/primes.m Mon Sep 22 20:46:54 2014 -0700 @@ -22,7 +22,7 @@ ## ## The output data class (double, single, uint32, etc.) is the same as ## the input class of @var{n}. The algorithm used is the Sieve of -## Eratosthenes. +## Eratosthenes. ## ## Notes: If you need a specific number of primes you can use the ## fact that the distance from one prime to the next is, on average, diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/statistics/base/lscov.m --- a/scripts/statistics/base/lscov.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/statistics/base/lscov.m Mon Sep 22 20:46:54 2014 -0700 @@ -29,7 +29,7 @@ ## ## The optional input argument @var{V} may be a n-by-1 vector of positive ## weights (inverse variances), or a n-by-n symmetric positive -## semidefinite matrix representing the covariance of @var{b}. If +## semidefinite matrix representing the covariance of @var{b}. If ## @var{V} is not supplied, the ordinary least squares solution is ## returned. ## @@ -37,12 +37,13 @@ ## is currently ignored. ## ## Besides the least-squares estimate matrix @var{x} (p-by-k), the -## function also returns @var{stdx} (p-by-k), the error standard +## function also returns @var{stdx} (p-by-k), the error standard ## deviation of estimated @var{x}; @var{mse} (k-by-1), the estimated ## data error covariance scale factors (@math{\sigma^2}); and @var{S} ## (p-by-p, or p-by-p-by-k if k > 1), the error covariance of @var{x}. ## -## Reference: Golub and Van Loan (1996), Matrix Computations (3rd Ed.), Johns Hopkins, Section 5.6.3 +## Reference: Golub and Van Loan (1996), Matrix Computations (3rd Ed.), Johns +## Hopkins, Section 5.6.3 ## ## @end deftypefn ## @seealso{ols, gls, lsqnonneg} diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/testfun/private/compare_plot_demos.m --- a/scripts/testfun/private/compare_plot_demos.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/testfun/private/compare_plot_demos.m Mon Sep 22 20:46:54 2014 -0700 @@ -24,7 +24,7 @@ ## html comparison of the plot demos for each of Octave's graphics toolkits. ## ## An m-file named @file{dump_plots.m} will be created in the current working -## directory. This function will be used to render and save the plot demo +## directory. This function will be used to render and save the plot demo ## images. ## ## If they do not already exist, directories for each available graphics diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/testfun/private/dump_demos.m --- a/scripts/testfun/private/dump_demos.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/testfun/private/dump_demos.m Mon Sep 22 20:46:54 2014 -0700 @@ -31,10 +31,12 @@ ## @table @var ## @item @var{dirs} ## @code{@{"plot/appearance", "plot/draw", "plot/util", "image"@}} +## ## @item @var{mfile} -## @code{"dump.m"} +## @qcode{"dump.m"} +## ## @item @var{fmt} -## @code{"png"} +## @qcode{"png"} ## @end table ## ## For example, to produce PNG output for all demos of the functions diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/testfun/private/html_compare_plot_demos.m --- a/scripts/testfun/private/html_compare_plot_demos.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/testfun/private/html_compare_plot_demos.m Mon Sep 22 20:46:54 2014 -0700 @@ -28,10 +28,13 @@ ## @table @samp ## @item fmt ## @code{"png"} +## ## @item output ## @code{"compare_plot_demos.html"} +## ## @item template ## @code{"html_plot_demos_template.html"} +## ## @item column_width ## @code{600} ## @end table diff -r e09318118fd6 -r 0f9c5a15c8fa scripts/testfun/test.m --- a/scripts/testfun/test.m Mon Sep 22 20:25:21 2014 -0700 +++ b/scripts/testfun/test.m Mon Sep 22 20:46:54 2014 -0700 @@ -32,8 +32,9 @@ ## ## @code{test} can be called in either command or functional form. The exact ## operation of test is determined by a combination of mode (interactive or -## batch), reporting level ("quiet", "normal", "verbose"), and whether a -## logfile or summary output variable is used. +## batch), reporting level (@qcode{"quiet"}, @qcode{"normal"}, +## @qcode{"verbose"}), and whether a logfile or summary output variable is +## used. ## ## The default mode when @code{test} is called from the command line is ## interactive. In this mode, tests will be run until the first error is