# HG changeset patch # User Rik # Date 1375646919 25200 # Node ID d6499c14021c90f8c23766cad75f170f295aca9b # Parent 9ba57ed052079ac36586235bf10e7dd46fac9fd4 doc: Periodic grammarcheck of documentation. * doc/interpreter/basics.txi, doc/interpreter/expr.txi, doc/interpreter/install.txi, doc/interpreter/java.txi, doc/interpreter/plot.txi, doc/interpreter/sparse.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/cellfun.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/pr-output.cc, libinterp/parse-tree/oct-parse.in.yy, liboctave/numeric/LSODE-opts.in, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/warning_ids.m, scripts/prefs/prefdir.m, scripts/prefs/preferences.m, scripts/signal/fftfilt.m, scripts/strings/isstrprop.m, scripts/testfun/assert.m: Periodic grammarcheck of documentation. diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/basics.txi --- a/doc/interpreter/basics.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/basics.txi Sun Aug 04 13:08:39 2013 -0700 @@ -530,7 +530,7 @@ @item C-l Clear the screen, reprinting the current line at the top. -@item C-_ +@item C-_ @itemx C-/ Undo the last action. You can undo all the way back to an empty line. @@ -610,7 +610,7 @@ for quickly correcting typing mistakes. @table @kbd -@item C-q +@item C-q @itemx C-v Add the next character that you type to the line verbatim. This is how to insert things like @kbd{C-q} for example. @@ -678,7 +678,7 @@ list. @table @kbd -@item @key{LFD} +@item @key{LFD} @itemx @key{RET} Accept the current line regardless of where the cursor is. If the line is non-empty, add it to the history list. If the line was a history diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/expr.txi --- a/doc/interpreter/expr.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/expr.txi Sun Aug 04 13:08:39 2013 -0700 @@ -583,7 +583,7 @@ Element-by-element left division. Each element of @var{y} is divided by each corresponding element of @var{x}. -@item @var{x} ^ @var{y} +@item @var{x} ^ @var{y} @itemx @var{x} ** @var{y} @opindex ** @opindex ^ @@ -597,7 +597,7 @@ The implementation of this operator needs to be improved. -@item @var{x} .^ @var{y} +@item @var{x} .^ @var{y} @itemx @var{x} .** @var{y} @opindex .** @opindex .^ @@ -759,7 +759,7 @@ @opindex > True if @var{x} is greater than @var{y}. -@item @var{x} != @var{y} +@item @var{x} != @var{y} @itemx @var{x} ~= @var{y} @opindex != @opindex ~= @@ -863,7 +863,7 @@ Elements of the result are true if either of the corresponding elements of @var{boolean1} or @var{boolean2} is true. -@item ! @var{boolean} +@item ! @var{boolean} @itemx ~ @var{boolean} @opindex ~ @opindex ! diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/install.txi --- a/doc/interpreter/install.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/install.txi Sun Aug 04 13:08:39 2013 -0700 @@ -179,7 +179,7 @@ @table @asis @item BLAS Basic Linear Algebra Subroutine library -(@url{http://www.netlib.org/blas}). Accelerated BLAS libraries such as +(@url{http://www.netlib.org/blas}). Accelerated @sc{blas} libraries such as ATLAS (@url{http://math-atlas.sourceforge.net}) are recommeded for better performance. diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/java.txi --- a/doc/interpreter/java.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/java.txi Sun Aug 04 13:08:39 2013 -0700 @@ -234,7 +234,7 @@ @item Finally, Octave looks for a next occurrence of file @file{javaclasspath.txt} in the m-files directory where Octave Java functions live. This is where @file{javaclasspath.m} resides, usually something like -@file{@env{OCTAVE_HOME}/share/octave/@env{OCTAVE_VERSION}/m/java/}. You can +@file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}. You can find this directory by executing the command @example @@ -330,7 +330,7 @@ The directory where the Java options file is located is specified by the environment variable @w{@env{OCTAVE_JAVA_DIR}}. If unset the directory where @file{javaclasspath.m} resides is used instead (typically -@file{@env{OCTAVE_HOME}/share/octave/@env{OCTAVE_VERSION}/m/java/}). You can +@file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}). You can find this directory by executing @example diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/plot.txi --- a/doc/interpreter/plot.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/plot.txi Sun Aug 04 13:08:39 2013 -0700 @@ -2871,23 +2871,23 @@ @item basevalue The value where the base of the area plot is drawn. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the edge of the patch objects making up the areas. @xref{Line Styles}. -@item edgecolor +@item edgecolor @itemx facecolor The line and fill color of the patch objects making up the areas. @xref{Colors}. -@item xdata +@item xdata @itemx ydata The x and y coordinates of the original columns of the data passed to @code{area} prior to the cumulative summation used in the @code{area} function. -@item xdatasource +@item xdatasource @itemx ydatasource Data source variables. @end table @@ -2902,7 +2902,7 @@ The properties of the bar series are @table @code -@item showbaseline +@item showbaseline @itemx baseline @itemx basevalue The property @code{showbaseline} flags whether the baseline of the bar @@ -2915,7 +2915,7 @@ properties of the base line itself are propagated to the members of the corresponding bar series. -@item barwidth +@item barwidth @itemx barlayout @itemx horizontal The property @code{barwidth} is the width of the bar corresponding to @@ -2927,12 +2927,12 @@ Changes to any of these property are propagated to the other members of the bar series. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the edge of the patch objects making up the bars. @xref{Line Styles}. -@item edgecolor +@item edgecolor @itemx facecolor The line and fill color of the patch objects making up the bars. @xref{Colors}. @@ -2943,7 +2943,7 @@ @item ydata The y value of the bars in the @code{hggroup}. -@item xdatasource +@item xdatasource @itemx ydatasource Data source variables. @end table @@ -2967,7 +2967,7 @@ A radio property that can have the values "on" or "off" that flags whether the contours to plot are to be filled. -@item zlevelmode +@item zlevelmode @itemx zlevel The radio property @code{zlevelmode} can have the values "none", "auto" or "manual". When its value is "none" there is no z component to the plotted @@ -2976,7 +2976,7 @@ z value at which to plot the contour is determined by the @code{zlevel} property. -@item levellistmode +@item levellistmode @itemx levellist @itemx levelstepmode @itemx levelstep @@ -2986,7 +2986,7 @@ @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} are set to "auto", then there are assumed to be 10 equal spaced contours. -@item textlistmode +@item textlistmode @itemx textlist @itemx textstepmode @itemx textstep @@ -3015,12 +3015,12 @@ contour line is drawn. If @code{linecolor} is "auto" then the line color is determined by the colormap. -@item xdata +@item xdata @itemx ydata @itemx zdata The original x, y, and z data of the contour lines. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource Data source variables. @@ -3040,18 +3040,18 @@ The RGB color or color name of the line objects of the error bars. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the line objects of the error bars. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor @itemx markersize The line and fill color of the markers on the error bars. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx ldata @itemx udata @@ -3059,7 +3059,7 @@ @itemx xudata The original x, y, l, u, xl, xu data of the error bars. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx ldatasource @itemx udatasource @@ -3081,22 +3081,22 @@ @item color The RGB color or color name of the line objects. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the line objects. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor @itemx markersize The line and fill color of the markers. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx zdata The original x, y and z data. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource Data source variables. @@ -3114,7 +3114,7 @@ properties of the quiver series are @table @code -@item autoscale +@item autoscale @itemx autoscalefactor Flag whether the length of the arrows is scaled or defined directly from the @var{u}, @var{v} and @var{w} data. If the arrow length is flagged @@ -3131,27 +3131,27 @@ @item color The RGB color or color name of the line objects of the quiver. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the line objects of the quiver. @xref{Line Styles}. -@item marker +@item marker @itemx markerfacecolor @itemx markersize The line and fill color of the marker objects at the original of the arrows. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx zdata The origins of the values of the vector field. -@item udata +@item udata @itemx vdata @itemx wdata The values of the vector field to plot. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource @itemx udatasource @@ -3174,12 +3174,12 @@ @item linewidth The line width of the line objects of the points. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor The line and fill color of the markers of the points. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx zdata The original x, y and z data of the stems. @@ -3192,7 +3192,7 @@ The size data for the points of the plot. Each point can its own size or a unique size can be specified. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource @itemx cdatasource @@ -3213,21 +3213,21 @@ @item color The RGB color or color name of the line objects of the stairs. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the line objects of the stairs. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor @itemx markersize The line and fill color of the markers on the stairs. @xref{Colors}. -@item xdata +@item xdata @itemx ydata The original x and y data of the stairs. -@item xdatasource +@item xdatasource @itemx ydatasource Data source variables. @end table @@ -3243,7 +3243,7 @@ are @table @code -@item showbaseline +@item showbaseline @itemx baseline @itemx basevalue The property @code{showbaseline} flags whether the baseline of the @@ -3260,22 +3260,22 @@ @item color The RGB color or color name of the line objects of the stems. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the line objects of the stems. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor @itemx markersize The line and fill color of the markers on the stems. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx zdata The original x, y and z data of the stems. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource Data source variables. @@ -3299,23 +3299,23 @@ The RGB color or color name of the edges or faces of the surface. @xref{Colors}. -@item linewidth +@item linewidth @itemx linestyle The line width and style of the lines on the surface. @xref{Line Styles}. -@item marker +@item marker @itemx markeredgecolor @itemx markerfacecolor @itemx markersize The line and fill color of the markers on the surface. @xref{Colors}. -@item xdata +@item xdata @itemx ydata @itemx zdata @itemx cdata The original x, y, z and c data. -@item xdatasource +@item xdatasource @itemx ydatasource @itemx zdatasource @itemx cdatasource diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/sparse.txi --- a/doc/interpreter/sparse.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/sparse.txi Sun Aug 04 13:08:39 2013 -0700 @@ -308,7 +308,7 @@ The above problem of memory reallocation can be avoided in oct-files. However, the construction of a sparse matrix from an oct-file is more complex than can be discussed here. @xref{External Code Interface}, -for a a full description of the techniques involved. +for a full description of the techniques involved. @node Information @subsection Finding Information about Sparse Matrices diff -r 9ba57ed05207 -r d6499c14021c doc/interpreter/vectorize.txi --- a/doc/interpreter/vectorize.txi Sun Aug 04 11:57:26 2013 -0700 +++ b/doc/interpreter/vectorize.txi Sun Aug 04 13:08:39 2013 -0700 @@ -606,7 +606,7 @@ @group a = zeros (1000); # create a 1000x1000 matrix b = a(:,10:100); # lazy slice -a = []; # the original a array is still allocated +a = []; # the original "a" array is still allocated c@{1@} = b; # b is reallocated at this point @end group @end example diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/cellfun.cc --- a/libinterp/corefcn/cellfun.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/cellfun.cc Sun Aug 04 13:08:39 2013 -0700 @@ -297,7 +297,7 @@ @item ndims\n\ Return the number of dimensions of each element.\n\ \n\ -@item numel\n\ +@item numel\n\ @itemx prodofsize\n\ Return the number of elements contained within each cell element. The\n\ number is the product of the dimensions of the object at each cell element.\n\ diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/debug.cc --- a/libinterp/corefcn/debug.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/debug.cc Sun Aug 04 13:08:39 2013 -0700 @@ -1041,7 +1041,7 @@ @deftypefn {Command} {} dblist\n\ @deftypefnx {Command} {} dblist @var{n}\n\ In debugging mode, list @var{n} lines of the function being debugged\n\ -centered around the the current line to be executed. If unspecified @var{n}\n\ +centered around the current line to be executed. If unspecified @var{n}\n\ defaults to 10 (+/- 5 lines)\n\ @seealso{dbwhere, dbtype}\n\ @end deftypefn") diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/file-io.cc --- a/libinterp/corefcn/file-io.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/file-io.cc Sun Aug 04 13:08:39 2013 -0700 @@ -1440,28 +1440,28 @@ data to read and may be one of\n\ \n\ @table @asis\n\ -@item \"schar\"\n\ +@item \"schar\"\n\ @itemx \"signed char\"\n\ Signed character.\n\ \n\ -@item \"uchar\"\n\ +@item \"uchar\"\n\ @itemx \"unsigned char\"\n\ Unsigned character.\n\ \n\ -@item \"int8\"\n\ +@item \"int8\"\n\ @itemx \"integer*1\"\n\ \n\ 8-bit signed integer.\n\ \n\ -@item \"int16\"\n\ +@item \"int16\"\n\ @itemx \"integer*2\"\n\ 16-bit signed integer.\n\ \n\ -@item \"int32\"\n\ +@item \"int32\"\n\ @itemx \"integer*4\"\n\ 32-bit signed integer.\n\ \n\ -@item \"int64\"\n\ +@item \"int64\"\n\ @itemx \"integer*8\"\n\ 64-bit signed integer.\n\ \n\ @@ -1477,17 +1477,17 @@ @item \"uint64\"\n\ 64-bit unsigned integer.\n\ \n\ -@item \"single\"\n\ +@item \"single\"\n\ @itemx \"float32\"\n\ @itemx \"real*4\"\n\ 32-bit floating point number.\n\ \n\ -@item \"double\"\n\ +@item \"double\"\n\ @itemx \"float64\"\n\ @itemx \"real*8\"\n\ 64-bit floating point number.\n\ \n\ -@item \"char\"\n\ +@item \"char\"\n\ @itemx \"char*1\"\n\ Single character.\n\ \n\ @@ -1500,15 +1500,15 @@ @item \"long\"\n\ Long integer (size is platform dependent).\n\ \n\ -@item \"ushort\"\n\ +@item \"ushort\"\n\ @itemx \"unsigned short\"\n\ Unsigned short integer (size is platform dependent).\n\ \n\ -@item \"uint\"\n\ +@item \"uint\"\n\ @itemx \"unsigned int\"\n\ Unsigned integer (size is platform dependent).\n\ \n\ -@item \"ulong\"\n\ +@item \"ulong\"\n\ @itemx \"unsigned long\"\n\ Unsigned long integer (size is platform dependent).\n\ \n\ diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/load-save.cc --- a/libinterp/corefcn/load-save.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/load-save.cc Sun Aug 04 13:08:39 2013 -0700 @@ -617,7 +617,7 @@ Octave can now support multi-dimensional HDF data and automatically\n\ modifies variable names if they are invalid Octave identifiers.\n\ \n\ -@item -mat\n\ +@item -mat\n\ @itemx -mat-binary\n\ @itemx -6\n\ @itemx -v6\n\ @@ -1509,20 +1509,20 @@ Only use this format if you know that all the\n\ values to be saved can be represented in single precision.\n\ \n\ -@item -V7\n\ +@item -V7\n\ @itemx -v7\n\ @itemx -7\n\ @itemx -mat7-binary\n\ Save the data in @sc{matlab}'s v7 binary data format.\n\ \n\ -@item -V6\n\ +@item -V6\n\ @itemx -v6\n\ @itemx -6\n\ @itemx -mat\n\ @itemx -mat-binary\n\ Save the data in @sc{matlab}'s v6 binary data format.\n\ \n\ -@item -V4\n\ +@item -V4\n\ @itemx -v4\n\ @itemx -4\n\ @itemx -mat4-binary\n\ @@ -1531,7 +1531,7 @@ @item -text\n\ Save the data in Octave's text data format. (default).\n\ \n\ -@item -zip\n\ +@item -zip\n\ @itemx -z\n\ Use the gzip algorithm to compress the file. This works equally on files\n\ that are compressed with gzip outside of octave, and gzip can equally be\n\ diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/matrix_type.cc --- a/libinterp/corefcn/matrix_type.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/matrix_type.cc Sun Aug 04 13:08:39 2013 -0700 @@ -84,7 +84,7 @@ matrix is assumed to be a permuted lower triangular with the permutations\n\ defined by the vector @var{perm}.\n\ \n\ -@item \"banded\"\n\ +@item \"banded\"\n\ @itemx \"banded positive definite\"\n\ Banded matrix with the band size of @var{nl} below the diagonal and @var{nu}\n\ above it. If @var{nl} and @var{nu} are 1, then the matrix is tridiagonal and\n\ diff -r 9ba57ed05207 -r d6499c14021c libinterp/corefcn/pr-output.cc --- a/libinterp/corefcn/pr-output.cc Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/corefcn/pr-output.cc Sun Aug 04 13:08:39 2013 -0700 @@ -3803,7 +3803,7 @@ @samp{e} format if it is unable to format a matrix properly using the\n\ current format.\n\ \n\ -@item short e\n\ +@item short e\n\ @itemx long e\n\ Exponential format. The number to be represented is split between a mantissa\n\ and an exponent (power of 10). The mantissa has 5 significant digits in the\n\ @@ -3811,14 +3811,14 @@ For example, with the @samp{short e} format, @code{pi} is displayed as\n\ @code{3.1416e+00}.\n\ \n\ -@item short E\n\ +@item short E\n\ @itemx long E\n\ Identical to @samp{short e} or @samp{long e} but displays an uppercase\n\ @samp{E} to indicate the exponent.\n\ For example, with the @samp{long E} format, @code{pi} is displayed as\n\ @code{3.14159265358979E+00}.\n\ \n\ -@item short g\n\ +@item short g\n\ @itemx long g\n\ Optimally choose between fixed point and exponential format based on\n\ the magnitude of the number.\n\ @@ -3837,19 +3837,19 @@ @end group\n\ @end example\n\ \n\ -@item short eng\n\ +@item short eng\n\ @itemx long eng\n\ Identical to @samp{short e} or @samp{long e} but displays the value\n\ using an engineering format, where the exponent is divisible by 3. For\n\ example, with the @samp{short eng} format, @code{10 * pi} is displayed as\n\ @code{31.4159e+00}.\n\ \n\ -@item long G\n\ +@item long G\n\ @itemx short G\n\ Identical to @samp{short g} or @samp{long g} but displays an uppercase\n\ @samp{E} to indicate the exponent.\n\ \n\ -@item free\n\ +@item free\n\ @itemx none\n\ Print output in free format, without trying to line up columns of\n\ matrices on the decimal point. This also causes complex numbers to be\n\ diff -r 9ba57ed05207 -r d6499c14021c libinterp/parse-tree/oct-parse.in.yy --- a/libinterp/parse-tree/oct-parse.in.yy Sun Aug 04 11:57:26 2013 -0700 +++ b/libinterp/parse-tree/oct-parse.in.yy Sun Aug 04 13:08:39 2013 -0700 @@ -3521,7 +3521,7 @@ DEFUN (autoload, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} autoload (@var{function}, @var{file})\n\ +@deftypefn {Built-in Function} {} autoload (@var{function}, @var{file})\n\ @deftypefnx {Built-in Function} {} autoload (@dots{}, @asis{\"remove\"})\n\ Define @var{function} to autoload from @var{file}.\n\ \n\ diff -r 9ba57ed05207 -r d6499c14021c liboctave/numeric/LSODE-opts.in --- a/liboctave/numeric/LSODE-opts.in Sun Aug 04 11:57:26 2013 -0700 +++ b/liboctave/numeric/LSODE-opts.in Sun Aug 04 13:08:39 2013 -0700 @@ -74,11 +74,11 @@ system. Valid values are @table @asis -@item \"adams\" +@item \"adams\" @itemx \"non-stiff\" No Jacobian used (even if it is available). -@item \"bdf\" +@item \"bdf\" @itemx \"stiff\" Use stiff backward differentiation formula (BDF) method. If a function to compute the Jacobian is not supplied, @code{lsode} will diff -r 9ba57ed05207 -r d6499c14021c scripts/image/imformats.m --- a/scripts/image/imformats.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/image/imformats.m Sun Aug 04 13:08:39 2013 -0700 @@ -34,18 +34,25 @@ ## @item ext ## The name of the file format. This may match the file extension but Octave ## will automatically detect the file format. +## ## @item description ## A long description of the file format. +## ## @item @nospell{isa} ## A function handle to confirm if a file is of the specified format. +## ## @item write ## A function handle to write if a file is of the specified format. +## ## @item read ## A function handle to open files the specified format. +## ## @item info ## A function handle to obtain image information of the specified format. +## ## @item alpha ## Logical value if format supports alpha channel (transparency or matte). +## ## @item multipage ## Logical value if format supports multipage (multiple images per file). ## @end table diff -r 9ba57ed05207 -r d6499c14021c scripts/image/imread.m --- a/scripts/image/imread.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/image/imread.m Sun Aug 04 13:08:39 2013 -0700 @@ -62,7 +62,7 @@ ## in this way, its value can also be the string "all". ## ## @item "Info" -## This option exists for @sc{Matlab} compatibility and has no effect. For +## This option exists for @sc{matlab} compatibility and has no effect. For ## maximum performance while reading multiple images from a single file, ## use the Index option. ## diff -r 9ba57ed05207 -r d6499c14021c scripts/image/imwrite.m --- a/scripts/image/imwrite.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/image/imwrite.m Sun Aug 04 13:08:39 2013 -0700 @@ -24,7 +24,7 @@ ## @deftypefnx {Function File} {} imwrite (@dots{}, @var{param1}, @var{val1}, @dots{}) ## Write images in various file formats. ## -## The image @var{img} can be a binary, grayscale, RGB, or multidimensional +## The image @var{img} can be a binary, grayscale, RGB, or multi-dimensional ## image. The size and class of @var{img} should be the same as what should ## be expected when reading it with @code{imread}: the 3rd and 4th dimensions ## reserved for colorspace, and multiple pages respectively. If it's an @@ -43,7 +43,7 @@ ## @item Quality ## Set the quality of the compression. The value should be an ## integer between 0 and 100, with larger values indicating higher visual -## quality and lower compression. Defaults to 75. +## quality and lower compression. Defaults to 75. ## ## @item WriteMode ## Some file formats, such as TIFF and GIF, are able to store multiple diff -r 9ba57ed05207 -r d6499c14021c scripts/miscellaneous/error_ids.m --- a/scripts/miscellaneous/error_ids.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/miscellaneous/error_ids.m Sun Aug 04 13:08:39 2013 -0700 @@ -44,6 +44,7 @@ ## exist but Octave is unable to find it in the search path. ## ## @end table +## function error_ids () diff -r 9ba57ed05207 -r d6499c14021c scripts/miscellaneous/fileattrib.m --- a/scripts/miscellaneous/fileattrib.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/miscellaneous/fileattrib.m Sun Aug 04 13:08:39 2013 -0700 @@ -39,19 +39,19 @@ ## @item directory ## True if @var{file} is a directory. ## -## @item UserRead +## @item UserRead ## @itemx GroupRead ## @itemx OtherRead ## True if the user (group; other users) has read permission for ## @var{file}. ## -## @item UserWrite +## @item UserWrite ## @itemx GroupWrite ## @itemx OtherWrite ## True if the user (group; other users) has write permission for ## @var{file}. ## -## @item UserExecute +## @item UserExecute ## @itemx GroupExecute ## @itemx OtherExecute ## True if the user (group; other users) has execute permission for diff -r 9ba57ed05207 -r d6499c14021c scripts/miscellaneous/mex.m --- a/scripts/miscellaneous/mex.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/miscellaneous/mex.m Sun Aug 04 13:08:39 2013 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} mex [options] file @dots{} +## @deftypefn {Command} {} mex [options] file @dots{} ## Compile source code written in C, C++, or Fortran, to a MEX file. ## This is equivalent to @code{mkoctfile --mex [options] file}. ## @seealso{mkoctfile} diff -r 9ba57ed05207 -r d6499c14021c scripts/miscellaneous/mkoctfile.m --- a/scripts/miscellaneous/mkoctfile.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/miscellaneous/mkoctfile.m Sun Aug 04 13:08:39 2013 -0700 @@ -46,7 +46,7 @@ ## @item -L DIR ## Add the library directory DIR to the link command. ## -## @item -M +## @item -M ## @itemx --depend ## Generate dependency files (.d) for C and C++ source files. ## @@ -67,13 +67,13 @@ ## @item -g ## Enable debugging options for compilers. ## -## @item -o FILE +## @item -o FILE ## @itemx --output FILE ## Output file name. Default extension is .oct ## (or .mex if @samp{--mex} is specified) unless linking ## a stand-alone executable. ## -## @item -p VAR +## @item -p VAR ## @itemx --print VAR ## Print the configuration variable VAR@. Recognized variables are: ## @@ -111,11 +111,11 @@ ## Assume we are creating a MEX file. Set the default output extension ## to ".mex". ## -## @item -s +## @item -s ## @itemx --strip ## Strip the output file. ## -## @item -v +## @item -v ## @itemx --verbose ## Echo commands as they are executed. ## diff -r 9ba57ed05207 -r d6499c14021c scripts/miscellaneous/warning_ids.m --- a/scripts/miscellaneous/warning_ids.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/miscellaneous/warning_ids.m Sun Aug 04 13:08:39 2013 -0700 @@ -333,6 +333,8 @@ ## expression. ## By default, the @code{Octave:variable-switch-label} warning is disabled. ## @end table +## + function warning_ids () help ("warning_ids"); diff -r 9ba57ed05207 -r d6499c14021c scripts/prefs/prefdir.m --- a/scripts/prefs/prefdir.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/prefs/prefdir.m Sun Aug 04 13:08:39 2013 -0700 @@ -17,18 +17,20 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} prefdir -## @deftypefnx {Function File} {@var{dir} =} prefdir +## @deftypefn {Command} {} prefdir +## @deftypefnx {Command} {@var{dir} =} prefdir ## Return the directory that contains the preferences for Octave. ## ## Examples: ## ## Display the preferences directory +## ## @example ## prefdir ## @end example ## ## Change to the preferences folder +## ## @example ## cd (prefdir) ## @end example diff -r 9ba57ed05207 -r d6499c14021c scripts/prefs/preferences.m --- a/scripts/prefs/preferences.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/prefs/preferences.m Sun Aug 04 13:08:39 2013 -0700 @@ -17,7 +17,7 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {} preferences +## @deftypefn {Command} {} preferences ## Display the GUI preferences dialog window for Octave. ## @end deftypefn diff -r 9ba57ed05207 -r d6499c14021c scripts/signal/fftfilt.m --- a/scripts/signal/fftfilt.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/signal/fftfilt.m Sun Aug 04 13:08:39 2013 -0700 @@ -24,7 +24,7 @@ ## ## Given the optional third argument, @var{n}, @code{fftfilt} uses the ## overlap-add method to filter @var{x} with @var{b} using an @var{n}-point -## FFT. The FFT size must be an even power of 2 and must be greater than +## FFT@. The FFT size must be an even power of 2 and must be greater than ## or equal to the length of @var{b}. If the specified @var{n} does not ## meet these criteria, it is automatically adjusted to the nearest value ## that does. diff -r 9ba57ed05207 -r d6499c14021c scripts/strings/isstrprop.m --- a/scripts/strings/isstrprop.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/strings/isstrprop.m Sun Aug 04 13:08:39 2013 -0700 @@ -38,7 +38,7 @@ ## @item "alpha" ## True for characters that are alphabetic (letters). ## -## @item "alnum" +## @item "alnum" ## @itemx "alphanum" ## True for characters that are alphabetic or digits. ## @@ -54,7 +54,7 @@ ## @item "xdigit" ## True for hexadecimal digits (@nospell{a-fA-F0-9}). ## -## @item "space" +## @item "space" ## @itemx "wspace" ## True for whitespace characters (space, formfeed, newline, carriage ## return, tab, vertical tab). @@ -66,7 +66,7 @@ ## @item "cntrl" ## True for control characters. ## -## @item "graph" +## @item "graph" ## @itemx "graphic" ## True for printing characters except space. ## diff -r 9ba57ed05207 -r d6499c14021c scripts/testfun/assert.m --- a/scripts/testfun/assert.m Sun Aug 04 11:57:26 2013 -0700 +++ b/scripts/testfun/assert.m Sun Aug 04 13:08:39 2013 -0700 @@ -27,7 +27,7 @@ ## be called in three different ways. ## ## @table @code -## @item assert (@var{cond}) +## @item assert (@var{cond}) ## @itemx assert (@var{cond}, @var{errmsg}, @dots{}) ## @itemx assert (@var{cond}, @var{msg_id}, @var{errmsg}, @dots{}) ## Called with a single argument @var{cond}, @code{assert} produces an